Références sur les API

L’API Datadog est une API HTTP REST. Elle utilise des URL orientées ressources pour appeler l’API, applique des codes de statut afin d’indiquer la réussite ou l’échec des requêtes, renvoie un objet JSON à partir de toutes les requêtes et tire profit des codes de réponse HTTP standard. Utilisez l’API Datadog pour accéder à la plateforme Datadog par programmation.

Prise en main

Authentifiez-vous auprès de l’API avec une clé d’API en utilisant l’en-tête DD-API-KEY. Pour certains endpoints, vous devez également utiliser une clé d’application, qui repose sur l’en-tête DD-APPLICATION-KEY.

Pour essayer l’API

Remarque : pour vous authentifier à l’API Datadog via Postman, ajoutez vos clés API et d’application Datadog aux variables de collection de la collection Datadog API.

La section Utiliser l’API présente le fonctionnement des endpoints.

Remarques :

Ajoutez vos clés API et d’application dans l’onglet Variables de la collection Datadog API.
Les exemples de code cURL supposent l’utilisation de BASH et des coreutils GNU. Sous macOS, vous pouvez installer coreutils avec le gestionnaire de paquets Homebrew : brew install coreutils.

Bibliothèques client

Par défaut, la documentation dédiée à l’API Datadog propose des exemples en cURL. Sélectionnez l’une de nos bibliothèques client officielles dans chaque endpoint pour voir des exemples de code pour cette bibliothèque. Pour installer chaque bibliothèque :

Installation

Maven - Ajoutez cette dépendance au fichier POM de votre projet :

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

Gradle - Ajoutez cette dépendance au fichier de build de votre projet :

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

Utilisation

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.*;

Remarque : remplacez <VERSION> par v1 ou v2 en fonction des endpoints que vous souhaitez utiliser.

Exemples

pom.xml Maven pour les exemples en cours d’exécution :

<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.44.0</version>
      <scope>compile</scope>
    </dependency>
  </dependencies>
</project>

Assurez-vous que la variable CLASSPATH contienne toutes les dépendances.

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

build.gradle Gradle pour les exemples en cours d’exécution :

plugins {
    id 'java'
    id 'application'
}

repositories {
    jcenter()
}

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

application {
    mainClassName = 'Example.java'
}

Lancez l’exemple en exécutant la commande gradle run.

Installationpip install datadog
Utilisationimport datadog

Installationpip3 install datadog-api-client
Utilisationimport datadog_api_client

Installationgem install dogapi
Utilisationrequire 'dogapi'

Installationgem install datadog_api_client -v 2.43.0
Utilisationrequire 'datadog_api_client'

Installation

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

Utilisation

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

Remarque : remplacez <VERSION> par V1 ou V2 en fonction des endpoints que vous souhaitez utiliser.

Installation

Le package est sous @datadog/datadog-api-client et peut être installé via NPM ou Yarn :

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

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

Utilisation

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

Remarque : remplacez <VERSION> par v1 ou v2 en fonction des endpoints que vous souhaitez utiliser.

Installation

Exécutez cargo add datadog-api-client ou ajoutez ce qui suit à Cargo.toml sous [dependencies] :

datadog-api-client = "0"

Utilisation

Essayez l’extrait suivant pour valider votre clé d’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());
    }
}