API 키 검증하기 - 키 관리

경고Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GEThttps://api.datadoghq.com/api/v2/validatehttps://api.us3.datadoghq.com/api/v2/validatehttps://api.us5.datadoghq.com/api/v2/validatehttps://api.datadoghq.eu/api/v2/validatehttps://api.ap1.datadoghq.com/api/v2/validatehttps://api.ap2.datadoghq.com/api/v2/validatehttps://api.uk1.datadoghq.com/api/v2/validatehttps://api.ddog-gov.com/api/v2/validatehttps://api.us2.ddog-gov.com/api/v2/validate

개요

API 키가 유효한지 확인합니다. 조직 UUID, API 키 ID 및 관련 범위를 반환합니다.

응답

Response for the API key validation endpoint.

항목

유형

설명

data [required]

object

Data object containing the API key validation result.

{
  "data": {
    "attributes": {
      "api_key_id": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6",
      "api_key_scopes": [
        "remote_config_read"
      ],
      "valid": true
    },
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "validate_v2"
  }
}

Forbidden

API error response.

항목

유형

설명

errors [required]

[object]

A list of errors.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

항목

유형

설명

errors [required]

[string]

A list of errors.

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

코드 예시

API 키 검증하기

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X GET "https://api.${DD_SITE}/api/v2/validate" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X GET "https://api.${DD_SITE}/api/v2/validate" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X GET "https://api.${DD_SITE}/api/v2/validate" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
export DD_API_KEY="<DD_API_KEY>"

curl -X GET "https://api.${DD_SITE}/api/v2/validate" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X GET "https://api.${DD_SITE}/api/v2/validate" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X GET "https://api.${DD_SITE}/api/v2/validate" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X GET "https://api.${DD_SITE}/api/v2/validate" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X GET "https://api.${DD_SITE}/api/v2/validate" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
export DD_API_KEY="<DD_API_KEY>"

curl -X GET "https://api.${DD_SITE}/api/v2/validate" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}"

API 키 검증하기

// Validate API 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() {
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.Validate", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewKeyManagementApi(apiClient)
	resp, r, err := api.Validate(ctx)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `KeyManagementApi.Validate`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `KeyManagementApi.Validate`:\n%s\n", responseContent)
}

Instructions

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

DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" go run "main.go"

DD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" go run "main.go"

DD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" go run "main.go"

DD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" go run "main.go"

DD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" go run "main.go"

DD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" go run "main.go"

DD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" go run "main.go"

DD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" go run "main.go"

DD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" go run "main.go"

API 키 검증하기

// Validate API 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.ValidateV2Response;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.validate", true);
    KeyManagementApi apiInstance = new KeyManagementApi(defaultClient);

    try {
      ValidateV2Response result = apiInstance.validate();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling KeyManagementApi#validate");
      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.com" DD_API_KEY="<DD_API_KEY>" java "Example.java"

DD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" java "Example.java"

DD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" java "Example.java"

DD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" java "Example.java"

DD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" java "Example.java"

DD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" java "Example.java"

DD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" java "Example.java"

DD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" java "Example.java"

DD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" java "Example.java"

API 키 검증하기

"""
Validate API key returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.key_management_api import KeyManagementApi

configuration = Configuration()
configuration.unstable_operations["validate"] = True
with ApiClient(configuration) as api_client:
    api_instance = KeyManagementApi(api_client)
    response = api_instance.validate()

    print(response)

Instructions

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

DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" python3 "example.py"

DD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" python3 "example.py"

DD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" python3 "example.py"

DD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" python3 "example.py"

DD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" python3 "example.py"

DD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" python3 "example.py"

DD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" python3 "example.py"

DD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" python3 "example.py"

DD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" python3 "example.py"

API 키 검증하기

# Validate API key returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.validate".to_sym] = true
end
api_instance = DatadogAPIClient::V2::KeyManagementAPI.new
p api_instance.validate()

Instructions

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

DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" rb "example.rb"

DD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" rb "example.rb"

DD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" rb "example.rb"

DD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" rb "example.rb"

DD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" rb "example.rb"

DD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" rb "example.rb"

DD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" rb "example.rb"

DD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" rb "example.rb"

DD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" rb "example.rb"

API 키 검증하기

// Validate API key returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_key_management::KeyManagementAPI;

#[tokio::main]
async fn main() {
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.validate", true);
    let api = KeyManagementAPI::with_config(configuration);
    let resp = api.validate().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.com" DD_API_KEY="<DD_API_KEY>" cargo run

DD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" cargo run

DD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" cargo run

DD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" cargo run

DD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" cargo run

DD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" cargo run

DD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" cargo run

DD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" cargo run

DD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" cargo run

API 키 검증하기

/**
 * Validate API key returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.validate"] = true;
const apiInstance = new v2.KeyManagementApi(configuration);

apiInstance
  .validate()
  .then((data: v2.ValidateV2Response) => {
    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.com" DD_API_KEY="<DD_API_KEY>" tsc "example.ts"

DD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" tsc "example.ts"

DD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" tsc "example.ts"

DD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" tsc "example.ts"

DD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" tsc "example.ts"

DD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" tsc "example.ts"

DD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" tsc "example.ts"

DD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" tsc "example.ts"

DD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" tsc "example.ts"