--- title: Get all API keys description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Key Management --- # Get all API keys{% #get-all-api-keys %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/api_keys | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/api_keys | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/api_keys | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/api_keys | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/api_keys | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/api_keys | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/api_keys | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/api_keys | ### Overview List all API keys available for your account. This endpoint requires the `api_keys_read` permission. ### Arguments #### Query Strings | Name | Type | Description | | ---------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | page[size] | integer | Size for a given page. The maximum allowed value is 100. | | page[number] | integer | Specific page number to return. | | sort | enum | 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. Allowed enum values: `created_at, -created_at, last4, -last4, modified_at, -modified_at, name, -name` | | filter | string | Filter API keys by the specified string. | | filter[created_at][start] | string | Only include API keys created on or after the specified date. | | filter[created_at][end] | string | Only include API keys created on or before the specified date. | | filter[modified_at][start] | string | Only include API keys modified on or after the specified date. | | filter[modified_at][end] | string | Only include API keys modified on or before the specified date. | | include | string | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. | | filter[remote_config_read_enabled] | boolean | Filter API keys by remote config read enabled status. | | filter[category] | string | Filter API keys by category. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response for a list of API keys. | Parent field | Field | Type | Description | | ------------- | ---------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------ | | | data | [object] | Array of API keys. | | data | attributes | object | Attributes of a partial API key. | | attributes | category | string | The category of the API key. | | attributes | created_at | string | Creation date of the API key. | | attributes | date_last_used | date-time | Date the API Key was last used. | | attributes | last4 | string | The last four characters of the API key. | | attributes | modified_at | string | Date the API key was last modified. | | attributes | name | string | Name of the API key. | | attributes | remote_config_read_enabled | boolean | The remote config read enabled status. | | data | id | string | ID of the API key. | | data | relationships | object | Resources related to the API key. | | relationships | created_by | object | Relationship to user. | | created_by | data [*required*] | object | Relationship to user object. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users` | | relationships | modified_by | object | Relationship to user. | | modified_by | data [*required*] | object | Relationship to user object. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users` | | data | type | enum | API Keys resource type. Allowed enum values: `api_keys` | | | included | [ ] | Array of objects related to the API key. | | included | Option 1 | object | User object returned by the API. | | Option 1 | attributes | object | Attributes of user object returned by the API. | | attributes | created_at | date-time | The ISO 8601 timestamp of when the user account was created. | | attributes | disabled | boolean | Whether the user account is deactivated. Disabled users cannot log in. | | attributes | email | string | The email address of the user, used for login and notifications. | | attributes | handle | string | The unique handle (username) of the user, typically matching their email prefix. | | attributes | icon | string | URL of the user's profile icon, typically a Gravatar URL derived from the email address. | | attributes | last_login_time | date-time | The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in. | | attributes | mfa_enabled | boolean | Whether multi-factor authentication (MFA) is enabled for the user's account. | | attributes | modified_at | date-time | The ISO 8601 timestamp of when the user account was last modified. | | attributes | name | string | The full display name of the user as shown in the Datadog UI. | | attributes | service_account | boolean | Whether this is a service account rather than a human user. Service accounts are used for programmatic API access. | | attributes | status | string | The current status of the user account (for example, `Active`, `Pending`, or `Disabled`). | | attributes | title | string | The job title of the user (for example, "Senior Engineer" or "Product Manager"). | | attributes | uuid | string | The globally unique identifier (UUID) of the user. | | attributes | verified | boolean | Whether the user's email address has been verified. | | Option 1 | id | string | ID of the user. | | Option 1 | relationships | object | Relationships of the user object returned by the API. | | relationships | org | object | Relationship to an organization. | | org | data [*required*] | object | Relationship to organization object. | | data | id [*required*] | string | ID of the organization. | | data | type [*required*] | enum | Organizations resource type. Allowed enum values: `orgs` | | relationships | other_orgs | object | Relationship to organizations. | | other_orgs | data [*required*] | [object] | Relationships to organization objects. | | data | id [*required*] | string | ID of the organization. | | data | type [*required*] | enum | Organizations resource type. Allowed enum values: `orgs` | | relationships | other_users | object | Relationship to users. | | other_users | data [*required*] | [object] | Relationships to user objects. | | data | id [*required*] | string | A unique identifier that represents the user. | | data | type [*required*] | enum | Users resource type. Allowed enum values: `users` | | relationships | roles | object | Relationship to roles. | | roles | data | [object] | An array containing type and the unique identifier of a role. | | data | id | string | The unique identifier of the role. | | data | type | enum | Roles type. Allowed enum values: `roles` | | Option 1 | type | enum | Users resource type. Allowed enum values: `users` | | included | Option 2 | object | The definition of LeakedKey object. | | Option 2 | attributes [*required*] | object | The definition of LeakedKeyAttributes object. | | attributes | date [*required*] | date-time | The LeakedKeyAttributes date. | | attributes | leak_source | string | The LeakedKeyAttributes leak_source. | | Option 2 | id [*required*] | string | The LeakedKey id. | | Option 2 | type [*required*] | enum | The definition of LeakedKeyType object. Allowed enum values: `leaked_keys` | | | meta | object | Additional information related to api keys response. | | meta | max_allowed | int64 | Max allowed number of API keys. | | meta | page | object | Additional information related to the API keys response. | | page | total_filtered_count | int64 | Total filtered application key count. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "category": "string", "created_at": "2020-11-23T10:00:00.000Z", "date_last_used": "2020-11-27T10:00:00.000Z", "last4": "abcd", "modified_at": "2020-11-23T10:00:00.000Z", "name": "API Key for submitting metrics", "remote_config_read_enabled": false }, "id": "string", "relationships": { "created_by": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } }, "modified_by": { "data": { "id": "00000000-0000-0000-0000-000000000000", "type": "users" } } }, "type": "api_keys" } ], "included": [ { "attributes": { "created_at": "2019-09-19T10:00:00.000Z", "disabled": false, "email": "string", "handle": "string", "icon": "string", "last_login_time": "2019-09-19T10:00:00.000Z", "mfa_enabled": false, "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", "service_account": false, "status": "string", "title": "string", "uuid": "string", "verified": false }, "id": "string", "relationships": { "org": { "data": { "id": "00000000-0000-beef-0000-000000000000", "type": "orgs" } }, "other_orgs": { "data": [ { "id": "00000000-0000-beef-0000-000000000000", "type": "orgs" } ] }, "other_users": { "data": [ { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } ] }, "roles": { "data": [ { "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "roles" } ] } }, "type": "users" } ], "meta": { "max_allowed": "integer", "page": { "total_filtered_count": "integer" } } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/api_keys" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get all API keys returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.key_management_api import KeyManagementApi # there is a valid "api_key" in the system API_KEY_DATA_ATTRIBUTES_NAME = environ["API_KEY_DATA_ATTRIBUTES_NAME"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = KeyManagementApi(api_client) response = api_instance.list_api_keys( filter=API_KEY_DATA_ATTRIBUTES_NAME, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get all API keys returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::KeyManagementAPI.new # there is a valid "api_key" in the system API_KEY_DATA_ATTRIBUTES_NAME = ENV["API_KEY_DATA_ATTRIBUTES_NAME"] opts = { filter: API_KEY_DATA_ATTRIBUTES_NAME, } p api_instance.list_api_keys(opts) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get all API keys returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { // there is a valid "api_key" in the system APIKeyDataAttributesName := os.Getenv("API_KEY_DATA_ATTRIBUTES_NAME") ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewKeyManagementApi(apiClient) resp, r, err := api.ListAPIKeys(ctx, *datadogV2.NewListAPIKeysOptionalParameters().WithFilter(APIKeyDataAttributesName)) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `KeyManagementApi.ListAPIKeys`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `KeyManagementApi.ListAPIKeys`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get all API keys returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.KeyManagementApi; import com.datadog.api.client.v2.api.KeyManagementApi.ListAPIKeysOptionalParameters; import com.datadog.api.client.v2.model.APIKeysResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); KeyManagementApi apiInstance = new KeyManagementApi(defaultClient); // there is a valid "api_key" in the system String API_KEY_DATA_ATTRIBUTES_NAME = System.getenv("API_KEY_DATA_ATTRIBUTES_NAME"); try { APIKeysResponse result = apiInstance.listAPIKeys( new ListAPIKeysOptionalParameters().filter(API_KEY_DATA_ATTRIBUTES_NAME)); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling KeyManagementApi#listAPIKeys"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get all API keys returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_key_management::KeyManagementAPI; use datadog_api_client::datadogV2::api_key_management::ListAPIKeysOptionalParams; #[tokio::main] async fn main() { // there is a valid "api_key" in the system let api_key_data_attributes_name = std::env::var("API_KEY_DATA_ATTRIBUTES_NAME").unwrap(); let configuration = datadog::Configuration::new(); let api = KeyManagementAPI::with_config(configuration); let resp = api .list_api_keys( ListAPIKeysOptionalParams::default().filter(api_key_data_attributes_name.clone()), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get all API keys returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.KeyManagementApi(configuration); // there is a valid "api_key" in the system const API_KEY_DATA_ATTRIBUTES_NAME = process.env .API_KEY_DATA_ATTRIBUTES_NAME as string; const params: v2.KeyManagementApiListAPIKeysRequest = { filter: API_KEY_DATA_ATTRIBUTES_NAME, }; apiInstance .listAPIKeys(params) .then((data: v2.APIKeysResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------ | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/api_key | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/api_key | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/api_key | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/api_key | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v1/api_key | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/api_key | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/api_key | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/api_key | ### Overview Get all API keys available for your account. **Note**: This endpoint is disabled for the Government sites (US1-FED and US2-FED). Use the [V2 Key Management](https://docs.datadoghq.com/api/latest/key-management.md) endpoints instead. This endpoint requires the `api_keys_read` permission. ### Response {% tab title="200" %} OK {% tab title="Model" %} List of API and application keys available for a given organization. | Parent field | Field | Type | Description | | ------------ | ---------- | -------- | --------------------------------------------- | | | api_keys | [object] | Array of API keys. | | api_keys | created | string | Date of creation of the API key. | | api_keys | created_by | string | Datadog user handle that created the API key. | | api_keys | key | string | API key. | | api_keys | name | string | Name of your API key. | {% /tab %} {% tab title="Example" %} ```json { "api_keys": [ { "created_by": "test_user", "key": "1234512345123456abcabc912349abcd", "name": "app_key" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/v1/api_key" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get all API keys returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.key_management_api import KeyManagementApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = KeyManagementApi(api_client) response = api_instance.list_api_keys() print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get all API keys returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::KeyManagementAPI.new p api_instance.list_api_keys() ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get all API keys returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewKeyManagementApi(apiClient) resp, r, err := api.ListAPIKeys(ctx) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `KeyManagementApi.ListAPIKeys`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `KeyManagementApi.ListAPIKeys`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get all API keys returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.KeyManagementApi; import com.datadog.api.client.v1.model.ApiKeyListResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); KeyManagementApi apiInstance = new KeyManagementApi(defaultClient); try { ApiKeyListResponse result = apiInstance.listAPIKeys(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling KeyManagementApi#listAPIKeys"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get all API keys returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_key_management::KeyManagementAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = KeyManagementAPI::with_config(configuration); let resp = api.list_api_keys().await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get all API keys returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.KeyManagementApi(configuration); apiInstance .listAPIKeys() .then((data: v1.ApiKeyListResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}