> ## Documentation Index > Fetch the complete documentation index at: https://docs.rootly.com/llms.txt > Use this file to discover all available pages before exploring further. # Lists AI SRE investigations > Investigations on alerts and incidents the caller can read, newest first. ## OpenAPI ````yaml https://rootly-heroku.s3.amazonaws.com/swagger/v1/swagger.json get /v1/investigations openapi: 3.0.1 info: title: Rootly API v1 version: v1 license: name: Rootly url: https://rootly.com description: >+ # How to generate an API Key? - **Organization dropdown** > **Organization Settings** > **API Keys** # JSON:API Specification Rootly is using **JSON:API** (https://jsonapi.org) specification: - JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. - JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability. - JSON:API requires use of the JSON:API media type (**application/vnd.api+json**) for exchanging data. # Authentication and Requests We use standard HTTP Authentication over HTTPS to authorize your requests. ``` curl --request GET \ --header 'Content-Type: application/vnd.api+json' \ --header 'Authorization: Bearer YOUR-TOKEN' \ --url https://api.rootly.com/v1/incidents ```
# Rate limiting - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - There is a default limit of **3** **POST**, **PUT**, **PATCH** or **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit is calculated over a **0-hour sliding window** looking back from the current time. While the limit can be configured to support higher thresholds, you must first contact your **Rootly Customer Success Manager** to make any adjustments. - When rate limits are exceeded, the API will return a **429 Too Many Requests** HTTP status code with the response: `{"error": "Rate limit exceeded. Try again later."}` - **X-RateLimit headers** are included in every API response, providing real-time rate limit information: - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., "1000, 1000;window=3600" for 1000 requests per hour) - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window - **X-RateLimit-Used** - The number of requests already made in the current window - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds # Pagination - Pagination is supported for all endpoints that return a collection of items. - Pagination is controlled by the **page** query parameter ## Example ``` curl --request GET \ --header 'Content-Type: application/vnd.api+json' \ --header 'Authorization: Bearer YOUR-TOKEN' \ --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10 ``` x-logo: url: https://rootly-heroku.s3.us-east-1.amazonaws.com/swagger/v1/logo.png servers: - url: https://api.rootly.com security: [] paths: /v1/investigations: get: tags: - Investigations summary: Lists AI SRE investigations description: >- Investigations on alerts and incidents the caller can read, newest first. operationId: ListInvestigations parameters: - name: filter[alert_id] in: query required: false schema: type: string format: uuid - name: filter[incident_id] in: query required: false schema: type: string format: uuid - name: filter[status] in: query required: false description: Comma-separated statuses. schema: type: string - name: filter[outcome] in: query required: false description: Comma-separated outcomes. schema: type: string - name: page[number] in: query required: false schema: type: integer - name: page[size] in: query required: false schema: type: integer responses: '200': description: filters by alert content: application/vnd.api+json: schema: $ref: '#/components/schemas/investigation_list' '403': description: AI SRE is disabled for the team content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_list' '422': description: rejects unknown statuses content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_list' security: - bearer_auth: [] components: schemas: investigation_list: type: object properties: data: type: array items: type: object properties: id: type: string format: uuid type: type: string enum: - investigations attributes: type: object properties: status: type: string enum: - pending - running - completed - failed - cancelled outcome: type: string nullable: true enum: - root_cause_identified - best_effort - inconclusive - blocked - could_not_investigate - null confidence: type: integer nullable: true trigger_source: type: string nullable: true alert_id: type: string format: uuid nullable: true incident_id: type: string format: uuid nullable: true url: type: string description: The investigation tab on the alert or incident page. started_at: type: string format: date-time nullable: true finished_at: type: string format: date-time nullable: true created_at: type: string format: date-time summary: type: string nullable: true root_cause: type: string nullable: true review_status: type: object nullable: true description: >- Set when the final review failed and the verdict rests on an earlier review round. properties: kind: type: string enum: - retained_prior_review message: type: string final_review_failed: type: string nullable: true retained_review_round: type: integer nullable: true retained_decision: type: string nullable: true enum: - accept - upgrade - null retained_kind: type: string nullable: true hypotheses: type: array items: type: object properties: id: type: string format: uuid claim: type: string summary: type: string nullable: true category: type: string nullable: true confidence: type: integer verdict: type: string enum: - confirmed - refuted - investigating - inconclusive evidence: type: array items: type: object properties: title: type: string detail: type: string source: type: string url: type: string weight: type: string enum: - decisive - supporting causal_chain: type: array items: type: object properties: edge: type: string at: type: string format: date-time evidence: type: string status: type: string enum: - confirmed - likely - refuted open_questions: type: array description: What the investigation could not verify. items: type: object properties: key: type: string question: type: string required: - key - question required: - status - url - created_at required: - id - type - attributes meta: $ref: '#/components/schemas/meta' required: - data - meta errors_list: type: object properties: errors: type: array items: type: object properties: title: type: string status: type: string code: type: string nullable: true detail: type: string nullable: true required: - title - status meta: type: object properties: next_cursor: type: string nullable: true current_page: type: integer nullable: true next_page: type: integer nullable: true prev_page: type: integer nullable: true total_count: type: integer total_pages: type: integer required: - current_page - next_page - prev_page - total_count - total_pages securitySchemes: bearer_auth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.