Revoke a personal access token

DELETE https://api.ap1.datadoghq.com/api/v2/personal_access_tokens/{token_id}https://api.ap2.datadoghq.com/api/v2/personal_access_tokens/{token_id}https://api.datadoghq.eu/api/v2/personal_access_tokens/{token_id}https://api.ddog-gov.com/api/v2/personal_access_tokens/{token_id}https://api.us2.ddog-gov.com/api/v2/personal_access_tokens/{token_id}https://api.datadoghq.com/api/v2/personal_access_tokens/{token_id}https://api.us3.datadoghq.com/api/v2/personal_access_tokens/{token_id}https://api.us5.datadoghq.com/api/v2/personal_access_tokens/{token_id}

Overview

Revoke a specific personal access token. This endpoint requires any of the following permissions:

  • user_app_keys
  • org_app_keys_write

  • Arguments

    Path Parameters

    Name

    Type

    Description

    token_id [required]

    string

    The ID of the access token.

    Response

    No Content

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Not Found

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
      "errors": [
        "Bad Request"
      ]
    }

    Code Example

                      # Path parameters
    export token_id="00000000-0000-1234-0000-000000000000"
    # Curl command
    curl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/personal_access_tokens/${token_id}" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
    """
    Revoke a personal access token returns "No Content" 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 "personal_access_token" in the system
    PERSONAL_ACCESS_TOKEN_DATA_ID = environ["PERSONAL_ACCESS_TOKEN_DATA_ID"]
    
    configuration = Configuration()
    with ApiClient(configuration) as api_client:
        api_instance = KeyManagementApi(api_client)
        api_instance.revoke_personal_access_token(
            pat_id=PERSONAL_ACCESS_TOKEN_DATA_ID,
        )
    

    Instructions

    First install the library and its dependencies and then save the example to example.py and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
    # Revoke a personal access token returns "No Content" response
    
    require "datadog_api_client"
    api_instance = DatadogAPIClient::V2::KeyManagementAPI.new
    
    # there is a valid "personal_access_token" in the system
    PERSONAL_ACCESS_TOKEN_DATA_ID = ENV["PERSONAL_ACCESS_TOKEN_DATA_ID"]
    api_instance.revoke_personal_access_token(PERSONAL_ACCESS_TOKEN_DATA_ID)
    

    Instructions

    First install the library and its dependencies and then save the example to example.rb and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
    // Revoke a personal access token returns "No Content" response
    
    package main
    
    import (
    	"context"
    	"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 "personal_access_token" in the system
    	PersonalAccessTokenDataID := os.Getenv("PERSONAL_ACCESS_TOKEN_DATA_ID")
    
    	ctx := datadog.NewDefaultContext(context.Background())
    	configuration := datadog.NewConfiguration()
    	apiClient := datadog.NewAPIClient(configuration)
    	api := datadogV2.NewKeyManagementApi(apiClient)
    	r, err := api.RevokePersonalAccessToken(ctx, PersonalAccessTokenDataID)
    
    	if err != nil {
    		fmt.Fprintf(os.Stderr, "Error when calling `KeyManagementApi.RevokePersonalAccessToken`: %v\n", err)
    		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    	}
    }
    

    Instructions

    First install the library and its dependencies and then save the example to main.go and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
    // Revoke a personal access token returns "No Content" response
    
    import com.datadog.api.client.ApiClient;
    import com.datadog.api.client.ApiException;
    import com.datadog.api.client.v2.api.KeyManagementApi;
    
    public class Example {
      public static void main(String[] args) {
        ApiClient defaultClient = ApiClient.getDefaultApiClient();
        KeyManagementApi apiInstance = new KeyManagementApi(defaultClient);
    
        // there is a valid "personal_access_token" in the system
        String PERSONAL_ACCESS_TOKEN_DATA_ID = System.getenv("PERSONAL_ACCESS_TOKEN_DATA_ID");
    
        try {
          apiInstance.revokePersonalAccessToken(PERSONAL_ACCESS_TOKEN_DATA_ID);
        } catch (ApiException e) {
          System.err.println("Exception when calling KeyManagementApi#revokePersonalAccessToken");
          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 and then save the example to Example.java and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
    // Revoke a personal access token returns "No Content" response
    use datadog_api_client::datadog;
    use datadog_api_client::datadogV2::api_key_management::KeyManagementAPI;
    
    #[tokio::main]
    async fn main() {
        // there is a valid "personal_access_token" in the system
        let personal_access_token_data_id = std::env::var("PERSONAL_ACCESS_TOKEN_DATA_ID").unwrap();
        let configuration = datadog::Configuration::new();
        let api = KeyManagementAPI::with_config(configuration);
        let resp = api
            .revoke_personal_access_token(personal_access_token_data_id.clone())
            .await;
        if let Ok(value) = resp {
            println!("{:#?}", value);
        } else {
            println!("{:#?}", resp.unwrap_err());
        }
    }
    

    Instructions

    First install the library and its dependencies and then save the example to src/main.rs and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
    /**
     * Revoke a personal access token returns "No Content" response
     */
    
    import { client, v2 } from "@datadog/datadog-api-client";
    
    const configuration = client.createConfiguration();
    const apiInstance = new v2.KeyManagementApi(configuration);
    
    // there is a valid "personal_access_token" in the system
    const PERSONAL_ACCESS_TOKEN_DATA_ID = process.env
      .PERSONAL_ACCESS_TOKEN_DATA_ID as string;
    
    const params: v2.KeyManagementApiRevokePersonalAccessTokenRequest = {
      patId: PERSONAL_ACCESS_TOKEN_DATA_ID,
    };
    
    apiInstance
      .revokePersonalAccessToken(params)
      .then((data: any) => {
        console.log(
          "API called successfully. Returned data: " + JSON.stringify(data)
        );
      })
      .catch((error: any) => console.error(error));
    

    Instructions

    First install the library and its dependencies and then save the example to example.ts and run following commands:

        
    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"