GET https://api.ap1.datadoghq.com/api/v1/validate https://api.datadoghq.eu/api/v1/validate https://api.ddog-gov.com/api/v1/validate https://api.datadoghq.com/api/v1/validate https://api.us3.datadoghq.com/api/v1/validate https://api.us5.datadoghq.com/api/v1/validate
Overview Comprueba si la clave de API (no la clave de aplicación) es válida. Si no es válida, se devuelve un 403.
Response OK
Represent validation endpoint responses.
Expand All
Return true if the authentication response is valid.
Authentication error
Error response object.
Expand All
Array of errors returned by the API.
{
"errors" : [
"Bad Request"
]
} Too many requests
Error response object.
Expand All
Array of errors returned by the API.
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Curl command curl -X GET "https://api.ap1.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v1/validate " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} "
"""
Validate API key returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v1.api.authentication_api import AuthenticationApi
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = AuthenticationApi ( 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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" python3 "example.py"
# Validate API key returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V1 :: AuthenticationAPI . 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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" rb "example.rb"
// 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/datadogV1"
)
func main () {
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV1 . NewAuthenticationApi ( apiClient )
resp , r , err := api . Validate ( ctx )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `AuthenticationApi.Validate`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `AuthenticationApi.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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" go run "main.go"
// Validate API key returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v1.api.AuthenticationApi ;
import com.datadog.api.client.v1.model.AuthenticationValidationResponse ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
AuthenticationApi apiInstance = new AuthenticationApi ( defaultClient );
try {
AuthenticationValidationResponse result = apiInstance . validate ();
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling AuthenticationApi#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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" java "Example.java"
// Validate API key returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV1 ::api_authentication ::AuthenticationAPI ;
#[tokio::main]
async fn main () {
let configuration = datadog ::Configuration ::new ();
let api = AuthenticationAPI ::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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" cargo run
/**
* Validate API key returns "OK" response
*/
import { client , v1 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v1 . AuthenticationApi ( configuration );
apiInstance
. validate ()
. then (( data : v1.AuthenticationValidationResponse ) => {
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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" tsc "example.ts"
