API リファレンス

Datadog では HTTP REST API を採用しており、リソース指向 URL を使用して API を呼び出します。リクエストの成否はステータスコードで示し、すべてのリクエストに対して JSON オブジェクトを返します。この場合には標準 HTTP 応答コードが使用されます。Datadog API を使用すると、プログラムを通じて Datadog のプラットフォームにアクセスすることができます。

はじめに

API への認証は、ヘッダー DD-API-KEY を用いて API キーで行います。エンドポイントによっては、ヘッダー DD-APPLICATION-KEY を使用したアプリケーションキーも必要です。

API を試すには Postman で実行

: Postman を通して Datadog API を認証するには、Datadog API コレクションに含まれるコレクション変数に、Datadog API とアプリケーションキーの値を追加します。

API の使用でエンドポイントについて説明しています。

:

  • Datadog API コレクションの Variables タブに API とアプリケーションキーの値を追加します。
  • cURL コード例は、BASH と GNU coreutils の使用を前提としています。macOS をお使いの場合は Homebrew package manager を使って Coreutils をダウンロードして、コマンド brew install coreutils でインストールできます。

クライアントライブラリ

デフォルトでは、Datadog API Docs には cURL で例が示されています。各エンドポイントの公式クライアントライブラリ言語から 1 つを選択すると、選択したライブラリのコード例を閲覧できます。各ライブラリをインストールするには、

インストール

Maven - この依存関係をプロジェクトの POM に追加します。

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

Gradle - この依存関係をプロジェクトのビルドファイルに追加します。

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

Usage

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

: 使用するエンドポイントに応じて、<VERSION> を v1 または v2 に置き換えてください。

例を実行するための Maven pom.xml:

<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> 

CLASSPATH 変数がすべての依存関係を含むことを確認してください。

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

例を実行するための Gradle build.gradle:

plugins {     id 'java'     id 'application' }  repositories {     jcenter() }  dependencies {     implementation 'com.datadoghq:datadog-api-client:2.44.0' }  application {     mainClassName = 'Example.java' } 

gradle run コマンドで例を実行します。

インストール

pip install datadog 

Usage

import datadog 

インストール

pip3 install datadog-api-client 

Usage

import datadog_api_client 

インストール

gem install dogapi 

Usage

require 'dogapi' 

インストール

gem install datadog_api_client -v 2.43.0 

Usage

require 'datadog_api_client' 

インストール

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

Usage

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

: 使用するエンドポイントに応じて、<VERSION>V1 または V2 に置き換えてください。

インストール

パッケージは @datadog/datadog-api-client の下にあり、NPM または Yarn を介してインストールできます。

# NPM npm install @datadog/datadog-api-client  # Yarn yarn add @datadog/datadog-api-client 

Usage

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

: 使用するエンドポイントに応じて、<VERSION> を v1 または v2 に置き換えてください。

インストール

cargo add datadog-api-client を実行するか、または [dependencies] の下の Cargo.toml に次を追加します。

datadog-api-client = "0" 

Usage

Datadog API キーを検証するには、次のスニペットを試してください。

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());     } } 

または、ライブラリディテクトリを参照します。

Java
Python
Ruby
Go
Typescript
Rust
代わりにアプリケーションのセットアップから始めたい場合は、Datadog の一般向け「はじめに」ドキュメントをご覧ください。

関連情報