ListAPIKeys
Retrieve and manage API keys for your Datadog account using customizable filters, sorting, and pagination to organize and monitor access efficiently.
Instructions
List all API keys available for your account.
Query Parameters:
- page[size]: Size for a given page. The maximum allowed value is 100.
- page[number]: Specific page number to return.
- sort: API key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign.
- filter: Filter API keys by the specified string.
- filter[created_at][start]: Only include API keys created on or after the specified date.
- filter[created_at][end]: Only include API keys created on or before the specified date.
- filter[modified_at][start]: Only include API keys modified on or after the specified date.
- filter[modified_at][end]: Only include API keys modified on or before the specified date.
- include: Comma separated list of resource paths for related resources to include in the response. Supported resource paths are
created_by
andmodified_by
. - filter[remote_config_read_enabled]: Filter API keys by remote config read enabled status.
- filter[category]: Filter API keys by category.
Responses:
- 200 (Success): OK
- Content-Type:
application/json
- Response Properties:
- data: Array of API keys.
- included: Array of objects related to the API key.
- Example:
- Content-Type:
- 400: Bad Request
- Content-Type:
application/json
- Response Properties:
- errors: A list of errors.
- Example:
- Content-Type:
- 403: Forbidden
- Content-Type:
application/json
- Response Properties:
- errors: A list of errors.
- Example:
- Content-Type:
- 429: Too many requests
- Content-Type:
application/json
- Response Properties:
- errors: A list of errors.
- Example:
- Content-Type:
Input Schema
Name | Required | Description | Default |
---|---|---|---|
filter | No | Filter API keys by the specified string. | |
filter[category] | No | Filter API keys by category. | |
filter[created_at][end] | No | Only include API keys created on or before the specified date. | |
filter[created_at][start] | No | Only include API keys created on or after the specified date. | |
filter[modified_at][end] | No | Only include API keys modified on or before the specified date. | |
filter[modified_at][start] | No | Only include API keys modified on or after the specified date. | |
filter[remote_config_read_enabled] | No | Filter API keys by remote config read enabled status. | |
include | No | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. | |
page[number] | No | Specific page number to return. | |
page[size] | No | Size for a given page. The maximum allowed value is 100. | |
sort | No | Sorting options | name |