Referencia de API

La API Datadog es una API REST HTTP. La API utiliza URL orientadas a recursos para llamar a la API, utiliza códigos de estado para indicar el éxito o el fracaso de las solicitudes, devuelve JSON de todas las solicitudes y utiliza códigos de respuesta HTTP estándar. Utiliza la API Datadog para acceder a la plataforma Datadog mediante programación.

Empezando

Autentícate en la API con una clave de API utilizando la cabecera DD-API-KEY. Para algunos endpoints, también necesitas una clave de aplicación, que utiliza la cabecera DD-APPLICATION-KEY.

Para probar la API

Nota: Para autenticarse en la API Datadog a través de Postman, añade tus valores de clave de API y de clave de aplicación Datadog a las variables de recopilación de la recopilación de la API Datadog.

El uso de la API es una guía de los endpoints.

Notas:

Añade tus valores de API y de clave de aplicación a la pestaña Variables de la recopilación de la API Datadog.
Los ejemplos de código cURL suponen el uso de coreutils BASH y GNU. En macOS, puedes instalar coreutils con el Gestor de paquetes Homebrew: brew install coreutils

Bibliotecas cliente

Por defecto, los documentos de la API Datadog muestran ejemplos en cURL. Selecciona uno de nuestros lenguajes oficiales de bibliotecas cliente en cada endpoint para ver ejemplos de código de ese biblioteca. Para instalar cada biblioteca:

Instalación

Maven - Añade esta dependencia al modelo de objetos de proyecto (POM) de tu proyecto:

<dependency>
  <groupId>com.datadoghq</groupId>
  <artifactId>datadog-api-client</artifactId>
  <version>2.34.1</version>
  <scope>compile</scope>
</dependency>

Gradle - Añade esta dependencia al archivo de compilación de tu proyecto:

compile "com.datadoghq:datadog-api-client:2.34.1"

Uso

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.Configuration;
import com.datadog.api.<VERSION>.client.api.*;
import com.datadog.api.<VERSION>.client.model.*;

Nota: Sustituye <VERSION> por v1 o v2, en función de los endpoints que quieras utilizar.

Ejemplos

Maven pom.xml para ejecutar ejemplos:

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>example</artifactId>
  <version>1</version>
  <dependencies>
    <dependency>
      <groupId>com.datadoghq</groupId>
      <artifactId>datadog-api-client</artifactId>
      <version>2.34.1</version>
      <scope>compile</scope>
    </dependency>
  </dependencies>
</project>

Asegúrate de que la variable CLASSPATH contiene todas las dependencias.

export CLASSPATH=$(mvn -q exec:exec -Dexec.executable=echo -Dexec.args="%classpath")

Gradle build.gradle para ejecutar ejemplos:

plugins {
    id 'java'
    id 'application'
}

repositories {
    jcenter()
}

dependencies {
    implementation 'com.datadoghq:datadog-api-client:2.34.1'
}

application {
    mainClassName = 'Example.java'
}

Ejemplo de ejecución con el comando gradle run.

Instalaciónpip install datadog
Usoimport datadog

Instalaciónpip3 install datadog-api-client
Usoimport datadog_api_client

Instalacióngem install dogapi
Usorequire 'dogapi'

Instalacióngem install datadog_api_client -v 2.32.0
Usorequire 'datadog_api_client'

Instalación

go mod init main && go get github.com/DataDog/datadog-api-client-go/v2/api/datadog

Uso

import (
        "github.com/DataDog/datadog-api-client-go/v2/api/datadog"
        "github.com/DataDog/datadog-api-client-go/v2/api/datadog<VERSION>"
)

Nota: Sustituye <VERSION> por V1 o V2, en función de los endpoints que quieras utilizar.

Instalación

El paquete está en @datadog/datadog-api-client y se puede instalar a través de NPM o Yarn:

# NPM
npm install @datadog/datadog-api-client

# Yarn
yarn add @datadog/datadog-api-client

Uso

import { <VERSION> } from 'datadog-api-client';

Nota: Sustituye <VERSION> por v1 o v2, en función de los endpoints que quieras utilizar.

Instalación

Ejecuta cargo add datadog-api-client o añade lo siguiente a Cargo.toml en [dependencies]:

datadog-api-client = "0"

Uso

Prueba el siguiente fragmento para validar la clave de tu API Datadog:

use datadog_api_client::datadog::Configuration;
use datadog_api_client::datadogV1::api_authentication::AuthenticationAPI;

#[tokio::main]
async fn main() {
    let configuration = 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());
    }
}