> ## 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. # List private agents > List this tenant's agents, including revoked and offline agents. Inventory pages omit provider snapshots to bound database and response costs; use Get private agent for provider inventory and last-reported health. Requires Private Agent management access plus the Private Agents and AI SRE features. Credentials and capability schemas are never returned. ## OpenAPI ````yaml https://rootly-heroku.s3.amazonaws.com/swagger/v1/swagger.json get /v1/private_agents 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/private_agents: get: tags: - Private Agents summary: List private agents description: >- List this tenant's agents, including revoked and offline agents. Inventory pages omit provider snapshots to bound database and response costs; use Get private agent for provider inventory and last-reported health. Requires Private Agent management access plus the Private Agents and AI SRE features. Credentials and capability schemas are never returned. operationId: listPrivateAgents parameters: - name: page[number] in: query schema: type: integer minimum: 1 required: false - name: page[size] in: query schema: type: integer minimum: 1 maximum: 1000 default: 50 required: false responses: '200': description: Agents listed content: application/vnd.api+json: schema: $ref: '#/components/schemas/private_agent_list' '401': description: Invalid or missing API credential security: - bearer_auth: [] components: schemas: private_agent_list: type: object required: - data - meta properties: data: type: array items: $ref: '#/components/schemas/private_agent_summary' meta: type: object private_agent_summary: type: object additionalProperties: false required: - id - type - attributes properties: id: type: string format: uuid type: type: string enum: - private_agents attributes: type: object additionalProperties: false required: - name - description - enabled - status - online - deployment_mode - agent_version - last_seen_at - schema_digest - created_at - updated_at properties: name: type: string description: type: string nullable: true description: >- Non-sensitive routing metadata. Do not include secrets or personal data. enabled: type: boolean description: >- For active agents, whether Rootly may advertise tools and assign new work. status: type: string enum: - active - revoked online: type: boolean description: >- Active agent seen within two minutes; does not imply all providers are healthy. deployment_mode: type: string enum: - combined - split-core agent_version: type: string last_seen_at: type: string format: date-time nullable: true schema_digest: type: string nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time securitySchemes: bearer_auth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.