--- title: Modifier une clé d'application description: Modifiez une clé d'application. breadcrumbs: Documentation > API > Modifier une clé d'application --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Modifier une clé d'application ## v2 (latest) | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------ | | app.datadoghq.com | PATCH https://api.datadoghq.com/api/v2/application_keys/{app_key_id} | | us3.datadoghq.com | PATCH https://api.us3.datadoghq.com/api/v2/application_keys/{app_key_id} | | us5.datadoghq.com | PATCH https://api.us5.datadoghq.com/api/v2/application_keys/{app_key_id} | | app.datadoghq.eu | PATCH https://api.datadoghq.eu/api/v2/application_keys/{app_key_id} | | ap1.datadoghq.com | PATCH https://api.ap1.datadoghq.com/api/v2/application_keys/{app_key_id} | | ap2.datadoghq.com | PATCH https://api.ap2.datadoghq.com/api/v2/application_keys/{app_key_id} | | uk1.datadoghq.com | PATCH https://api.uk1.datadoghq.com/api/v2/application_keys/{app_key_id} | | app.ddog-gov.com | PATCH https://api.ddog-gov.com/api/v2/application_keys/{app_key_id} | | us2.ddog-gov.com | PATCH https://api.us2.ddog-gov.com/api/v2/application_keys/{app_key_id} | ### Overview Modifiez une clé d'application. This endpoint requires the `org_app_keys_write` permission. ### Arguments #### Path Parameters | Field | Type | Description | | ----------------------- | ------ | ------------------------------ | | app_key_id [*required*] | string | The ID of the application key. | ### Request #### Body Data (required) {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | ------------ | ----------------------- | -------- | ----------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Requête utilisée pour mettre à jour une clé d'application. | | data | attributes [*required*] | object | Attributes used to update an application Key. | | attributes | name | string | Name of the application key. | | attributes | scopes | [string] | Array of scopes to grant the application key. | | data | id [*required*] | string | ID of the application key. | | data | type [*required*] | enum | Application Keys resource type. Allowed enum values: `application_keys`. Default: `application_keys`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "id": "string", "type": "application_keys", "attributes": { "name": "Application Key for managing dashboards-updated" } } } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response for retrieving an application key. | Parent field | Field | Type | Description | | ------------------ | ------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | Datadog application key. | | data | attributes | object | Attributes of a full application key. | | attributes | created_at | date-time | Creation date of the application key. Read-only. | | attributes | key | string | The application key. Read-only. | | attributes | last4 | string | The last four characters of the application key. Read-only. | | attributes | last_used_at | date-time | Last usage timestamp of the application key. Read-only. | | attributes | name | string | Name of the application key. | | attributes | scopes | [string] | Array of scopes to grant the application key. | | data | id | string | ID of the application key. | | data | relationships | object | Resources related to the application key. | | relationships | owned_by | object | Relationship to user. | | owned_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`. Default: `users`. | | data | type | enum | Application Keys resource type. Allowed enum values: `application_keys`. Default: `application_keys`. | | | included | [] | Array of objects related to the application key. | | included | | object | User object returned by the API. | | | 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. Read-only. | | attributes | mfa_enabled | boolean | Whether multi-factor authentication (MFA) is enabled for the user's account. Read-only. | | 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. Read-only. | | attributes | verified | boolean | Whether the user's email address has been verified. | | | id | string | ID of the user. | | | 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`. Default: `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`. Default: `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`. Default: `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`. Default: `roles`. | | | type | enum | Users resource type. Allowed enum values: `users`. Default: `users`. | | included | | object | Role object returned by the API. | | | attributes | object | Attributes of the role. | | attributes | created_at | date-time | Creation time of the role. Read-only. | | attributes | modified_at | date-time | Time of last role modification. Read-only. | | attributes | name | string | The name of the role. The name is neither unique nor a stable identifier of the role. | | attributes | receives_permissions_from | [string] | The managed role from which this role automatically inherits new permissions. Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role. | | attributes | user_count | int64 | Number of users with that role. Read-only. | | | id | string | The unique identifier of the role. | | | relationships | object | Relationships of the role object returned by the API. | | relationships | permissions | object | Relationship to multiple permissions objects. | | permissions | data | [object] | Relationships to permission objects. | | data | id | string | ID of the permission. | | data | type | enum | Permissions resource type. Allowed enum values: `permissions`. Default: `permissions`. | | | type [*required*] | enum | Roles type. Allowed enum values: `roles`. Default: `roles`. | | included | | object | The definition of LeakedKey object. | | | attributes [*required*] | object | The definition of LeakedKeyAttributes object. | | attributes | date [*required*] | date-time | The LeakedKeyAttributes date. | | attributes | leak_source | string | The LeakedKeyAttributes leak_source. | | | id [*required*] | string | The LeakedKey id. | | | type [*required*] | enum | The definition of LeakedKeyType object. Allowed enum values: `leaked_keys`. Default: `leaked_keys`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "created_at": "2020-11-23T10:00:00.000Z", "key": "string", "last4": "abcd", "last_used_at": "2020-12-20T10:00:00.000Z", "name": "Application Key for managing dashboards", "scopes": [ "dashboards_read", "dashboards_write", "dashboards_public_share" ] }, "id": "string", "relationships": { "owned_by": { "data": { "id": "00000000-0000-0000-2345-000000000000", "type": "users" } } }, "type": "application_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" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not Found {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export app_key_id="CHANGE_ME" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X PATCH "https://api.${DD_SITE}/api/v2/application_keys/${app_key_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "id": "string", "type": "application_keys", "attributes": { "name": "Application Key for managing dashboards-updated" } } } EOF ``` {% /tab %} {% tab label="Go" %} ```go // Edit an application key 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 "application_key" in the system ApplicationKeyDataID := os.Getenv("APPLICATION_KEY_DATA_ID") body := datadogV2.ApplicationKeyUpdateRequest{ Data: datadogV2.ApplicationKeyUpdateData{ Id: ApplicationKeyDataID, Type: datadogV2.APPLICATIONKEYSTYPE_APPLICATION_KEYS, Attributes: datadogV2.ApplicationKeyUpdateAttributes{ Name: datadog.PtrString("Application Key for managing dashboards-updated"), }, }, } ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewKeyManagementApi(apiClient) resp, r, err := api.UpdateApplicationKey(ctx, ApplicationKeyDataID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `KeyManagementApi.UpdateApplicationKey`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `KeyManagementApi.UpdateApplicationKey`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Edit an application key 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.model.ApplicationKeyResponse; import com.datadog.api.client.v2.model.ApplicationKeyUpdateAttributes; import com.datadog.api.client.v2.model.ApplicationKeyUpdateData; import com.datadog.api.client.v2.model.ApplicationKeyUpdateRequest; import com.datadog.api.client.v2.model.ApplicationKeysType; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); KeyManagementApi apiInstance = new KeyManagementApi(defaultClient); // there is a valid "application_key" in the system String APPLICATION_KEY_DATA_ATTRIBUTES_NAME = System.getenv("APPLICATION_KEY_DATA_ATTRIBUTES_NAME"); String APPLICATION_KEY_DATA_ID = System.getenv("APPLICATION_KEY_DATA_ID"); ApplicationKeyUpdateRequest body = new ApplicationKeyUpdateRequest() .data( new ApplicationKeyUpdateData() .id(APPLICATION_KEY_DATA_ID) .type(ApplicationKeysType.APPLICATION_KEYS) .attributes( new ApplicationKeyUpdateAttributes() .name("Application Key for managing dashboards-updated"))); try { ApplicationKeyResponse result = apiInstance.updateApplicationKey(APPLICATION_KEY_DATA_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling KeyManagementApi#updateApplicationKey"); 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Edit an application key 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 from datadog_api_client.v2.model.application_key_update_attributes import ApplicationKeyUpdateAttributes from datadog_api_client.v2.model.application_key_update_data import ApplicationKeyUpdateData from datadog_api_client.v2.model.application_key_update_request import ApplicationKeyUpdateRequest from datadog_api_client.v2.model.application_keys_type import ApplicationKeysType # there is a valid "application_key" in the system APPLICATION_KEY_DATA_ATTRIBUTES_NAME = environ["APPLICATION_KEY_DATA_ATTRIBUTES_NAME"] APPLICATION_KEY_DATA_ID = environ["APPLICATION_KEY_DATA_ID"] body = ApplicationKeyUpdateRequest( data=ApplicationKeyUpdateData( id=APPLICATION_KEY_DATA_ID, type=ApplicationKeysType.APPLICATION_KEYS, attributes=ApplicationKeyUpdateAttributes( name="Application Key for managing dashboards-updated", ), ), ) configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = KeyManagementApi(api_client) response = api_instance.update_application_key(app_key_id=APPLICATION_KEY_DATA_ID, body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Edit an application key returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::KeyManagementAPI.new # there is a valid "application_key" in the system APPLICATION_KEY_DATA_ATTRIBUTES_NAME = ENV["APPLICATION_KEY_DATA_ATTRIBUTES_NAME"] APPLICATION_KEY_DATA_ID = ENV["APPLICATION_KEY_DATA_ID"] body = DatadogAPIClient::V2::ApplicationKeyUpdateRequest.new({ data: DatadogAPIClient::V2::ApplicationKeyUpdateData.new({ id: APPLICATION_KEY_DATA_ID, type: DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS, attributes: DatadogAPIClient::V2::ApplicationKeyUpdateAttributes.new({ name: "Application Key for managing dashboards-updated", }), }), }) p api_instance.update_application_key(APPLICATION_KEY_DATA_ID, body) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Edit an application key returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_key_management::KeyManagementAPI; use datadog_api_client::datadogV2::model::ApplicationKeyUpdateAttributes; use datadog_api_client::datadogV2::model::ApplicationKeyUpdateData; use datadog_api_client::datadogV2::model::ApplicationKeyUpdateRequest; use datadog_api_client::datadogV2::model::ApplicationKeysType; #[tokio::main] async fn main() { // there is a valid "application_key" in the system let application_key_data_id = std::env::var("APPLICATION_KEY_DATA_ID").unwrap(); let body = ApplicationKeyUpdateRequest::new(ApplicationKeyUpdateData::new( ApplicationKeyUpdateAttributes::new() .name("Application Key for managing dashboards-updated".to_string()), application_key_data_id.clone(), ApplicationKeysType::APPLICATION_KEYS, )); let configuration = datadog::Configuration::new(); let api = KeyManagementAPI::with_config(configuration); let resp = api .update_application_key(application_key_data_id.clone(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Edit an application key returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.KeyManagementApi(configuration); // there is a valid "application_key" in the system const APPLICATION_KEY_DATA_ID = process.env.APPLICATION_KEY_DATA_ID as string; const params: v2.KeyManagementApiUpdateApplicationKeyRequest = { body: { data: { id: APPLICATION_KEY_DATA_ID, type: "application_keys", attributes: { name: "Application Key for managing dashboards-updated", }, }, }, appKeyId: APPLICATION_KEY_DATA_ID, }; apiInstance .updateApplicationKey(params) .then((data: v2.ApplicationKeyResponse) => { 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %} ## v1 | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------- | | app.datadoghq.com | PUT https://api.datadoghq.com/api/v1/application_key/{key} | | us3.datadoghq.com | PUT https://api.us3.datadoghq.com/api/v1/application_key/{key} | | us5.datadoghq.com | PUT https://api.us5.datadoghq.com/api/v1/application_key/{key} | | app.datadoghq.eu | PUT https://api.datadoghq.eu/api/v1/application_key/{key} | | ap1.datadoghq.com | PUT https://api.ap1.datadoghq.com/api/v1/application_key/{key} | | ap2.datadoghq.com | PUT https://api.ap2.datadoghq.com/api/v1/application_key/{key} | | uk1.datadoghq.com | PUT https://api.uk1.datadoghq.com/api/v1/application_key/{key} | | app.ddog-gov.com | PUT https://api.ddog-gov.com/api/v1/application_key/{key} | | us2.ddog-gov.com | PUT https://api.us2.ddog-gov.com/api/v1/application_key/{key} | ### Overview Modifiez le nom d'une clé d'application. Cet endpoint est désactivé pour les organisations utilisant le [mode Lecture unique](https://docs.datadoghq.com/account_management/api-app-keys.md#mode-lecture-unique). This endpoint requires any of the following permissions: - `org_app_keys_write` - `user_app_keys` ### Arguments #### Path Parameters | Field | Type | Description | | ---------------- | ------ | ------------------------------------------ | | key [*required*] | string | The specific APP key you are working with. | ### Request #### Body Data (required) {% tabs %} {% tab label="Model" %} | Field | Type | Description | | ----- | ------ | ----------------------------------------------------- | | name | string | Une clé d'application avec ses métadonnées associées. | {% /tab %} {% tab label="Example" %} ```json { "name": "example user" } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} An application key response. | Parent field | Field | Type | Description | | --------------- | --------------- | ------ | ------------------------------------------------ | | | application_key | object | An application key with its associated metadata. | | application_key | hash | string | Hash of an application key. Read-only. | | application_key | name | string | Name of an application key. | | application_key | owner | string | Owner of an application key. Read-only. | {% /tab %} {% tab label="Example" %} ```json { "application_key": { "hash": "1234512345123459cda4eb9ced49a3d84fd0138c", "name": "app_key", "owner": "test_user" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not Found {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="409" %} Conflict {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export key="CHANGE_ME" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X PUT "https://api.${DD_SITE}/api/v1/application_key/${key}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "name": "example key" } EOF ``` {% /tab %} {% tab label="Go" %} ```go // Edit an application key 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() { body := datadogV1.ApplicationKey{ Name: datadog.PtrString("example user"), } ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewKeyManagementApi(apiClient) resp, r, err := api.UpdateApplicationKey(ctx, "key", body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `KeyManagementApi.UpdateApplicationKey`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `KeyManagementApi.UpdateApplicationKey`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Edit an application key 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.ApplicationKey; import com.datadog.api.client.v1.model.ApplicationKeyResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); KeyManagementApi apiInstance = new KeyManagementApi(defaultClient); ApplicationKey body = new ApplicationKey().name("example user"); try { ApplicationKeyResponse result = apiInstance.updateApplicationKey("key", body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling KeyManagementApi#updateApplicationKey"); 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Edit an application key returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.key_management_api import KeyManagementApi from datadog_api_client.v1.model.application_key import ApplicationKey body = ApplicationKey( name="example user", ) configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = KeyManagementApi(api_client) response = api_instance.update_application_key(key="key", body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Edit an application key returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V1::KeyManagementAPI.new body = DatadogAPIClient::V1::ApplicationKey.new({ name: "example user", }) p api_instance.update_application_key("key", body) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Edit an application key returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_key_management::KeyManagementAPI; use datadog_api_client::datadogV1::model::ApplicationKey; #[tokio::main] async fn main() { let body = ApplicationKey::new().name("example user".to_string()); let configuration = datadog::Configuration::new(); let api = KeyManagementAPI::with_config(configuration); let resp = api.update_application_key("key".to_string(), body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Edit an application key returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v1.KeyManagementApi(configuration); const params: v1.KeyManagementApiUpdateApplicationKeyRequest = { body: { name: "example user", }, key: "key", }; apiInstance .updateApplicationKey(params) .then((data: v1.ApplicationKeyResponse) => { 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}