This section details Datadog’s HTTP API for getting data in and out of Datadog.
To get started on Datadog HTTP API, use our Datadog Postman collection
The Datadog API uses resource-oriented URLs, uses status codes to indicate the success or failure of requests and returns JSON from all requests. Let’s dive in and see how it works.
Note: cURL code examples assume usage of BASH and GNU coreutils. On macOS you can install coreutils via the Homebrew package manager: brew install coreutils
There are many client libraries that wrap the Datadog API.
https://api.datadoghq.com/api/https://api.datadoghq.eu/api/Datadog の API へのすべてのリクエストに認証が必要です。データ書き込みリクエストには、レポートアクセス権と API キーが必要です。データ読み取りリクエストには、フルアクセス権のほかにアプリケーションキーも必要です。
from datadog import initialize, api
options = {'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'}
initialize(**options)
require 'rubygems'
require 'dogapi'
dog = Dogapi::Client.new('<YOUR_API_KEY>', '<YOUR_APP_KEY>')
curl "https://api.datadoghq.com/api/v1/validate?api_key=<YOUR_API_KEY>"
Datadog API は、リクエストが成功したか失敗したかを HTTP ステータスコードで示します。
エラーは、サービスがリクエストを正しく処理しなかったことを示します。応答には、ステータスコードのほかに、詳細なエラーメッセージをエラー配列として含む JSON オブジェクトが含まれる場合があります。注: ライブラリを使用している場合、一部のエラーは、JSON オブジェクトを返す代わりに例外を生成します。
サービスがリクエストを処理できたのに何らかの問題が発生している場合 (たとえば、非推奨の API または API バージョンを使用している場合)、HTTP ステータスコードは成功を示し、応答本文には期待される結果のほかに、詳細な警告メッセージを含む警告配列も含まれます。
200 OK201 Created202 Accepted204 No Content301 Moved Permanently304 Not Modified401 Unauthorized403 Forbidden404 Not Found409 Conflict413 Payload Too Large422 Unprocessable429 Too Many Requests500 Server Error{ 'errors': [
'Something bad happened to the server.',
'Your query made the server very sad.'
]
}
{ 'some_thing': ...,
'some_other_thing': ...,
'warnings': [
'This is a deprecated API.'
]
}
一部の API エンドポイントでは、レートが制限されています。一定の時間内に所定のリクエスト数を超過すると、エラーが返されます。
レート制限がある API エンドポイントについては、ヘッダーが返されるので、制限にどの程度近づいているかを知ることができます。また、制限を超えた場合は、このヘッダーを確認して、いつ再試行できるかを判断できます。
デフォルトのレート制限を増加させたい場合は、Datadog のサポートチームにお問い合わせください。
API レート制限ポリシーについて
100/時間/Organization です。1000/集計/日/Organization です。集計は、類似のイベントのグループです。300/時間/Organization です。これは、オンデマンドで増やすことができます。60/時間/Organization です。これは、オンデマンドで増やすことができます。6000/分/Organization です。これは、オンデマンドで増やすことができます。X-RateLimit-Limit number of requests allowed in a time periodX-RateLimit-Period length of time in seconds for resets (calendar aligned)X-RateLimit-Remaining number of allowed requests left in current time periodX-RateLimit-Reset time in seconds until next resetDatadog は、すべてのデータをキューに置いて非同期処理するため、API フロントエンドでは最小限のエラーチェックのみを行っています (これは、Datadog のシステムをお客様のシステムから切り離し、実稼働状態のお客様のデータを常に受け入れ続けるためです)。
したがって、202 の「成功」応答を受け取ることができても、そのデータが Datadog に表示されないことがあります。最も可能性が高い原因として、以下が挙げられます。
タイムスタンプが適切かどうかを確認するには、以下のコマンドを実行します。
date -u && curl -s -v https://app.datadoghq.com 2>&1 | grep -i '< date'
これは、現在のシステムの日付を出力してから、API エンドポイントの 1 つに、Datadog 側の日付を取得するようにリクエストを行います。これらの値が数分以上離れている場合は、サーバーの時間設定を確認する必要があります。
また、送信に必須ではないが、有効な入力を必要するフィールドもあります。たとえば、イベントを送信する際、priority フィールドには、4 つのオプションのいずれかが入力されている必要があります。
他のテキストを指定すると、コード 202 の「成功」の結果になりますが、イベントは表示されません。source_type_name が無効であっても、イベントの表示は妨げられませんが、そのフィールドは送信時に削除されます。
注: Datadog API キーは大文字と小文字が区別されます。POST エンドポイントの JSON 属性はすべて小文字にする必要があります。
サービスチェックエンドポイントを使用すると、モニターで使用されるチェックステータスをポストできます。
サービスチェックのメッセージは 500 文字に制限されます。500 文字を超えるメッセージを含むチェックがポストされた場合は、最初の 500 文字だけが表示されます。
check [必須]:
メッセージのテキスト
host_name [必須]:
チェックを送信するホストの名前
status [必須]:
チェックのステータスを示す整数値
timestamp [オプション]:
イベントの POSIX タイムスタンプ
message [オプション]:
このステータスが発生した理由の説明
tags [オプション]:
このチェックのキー:値タグのリスト
POST /v1/check_run
from datadog import initialize, api
from datadog.api.constants import CheckStatus
options = {'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'}
initialize(**options)
check = 'app.ok'
host = 'app1'
status = CheckStatus.OK # equals 0
tags = ['env:test']
api.ServiceCheck.check(check=check, host_name=host, status=status, message='Response: 200 OK', tags=tags)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# submitting a check doesn't require an app_key
dog = Dogapi::Client.new(api_key)
dog.service_check('app.is_ok', 'app1', 0, :message => 'Response: 200 OK', :tags => ['env:test'])
currenttime=$(date +%s)
curl -X POST -H "Content-type: application/json" \
-d "{
\"check\": \"app.is_ok\",
\"host_name\": \"app1\",
\"timestamp\": $currenttime,
\"status\": 0,
\"tags\": [\"env:test\"]
}" \
"https://api.datadoghq.com/api/v1/check_run?api_key=<YOUR_API_KEY>"
{
'status': 'ok'
}
["202", {
"status" => "ok"
}]
{
"status": "ok"
}
コメントは、Datadog について議論を交わす場です。コメントを作成、編集、削除、返信します。
コメントは、基本的に、イベントストリームに表示される特別な形式のイベントです。新しいディスカッションスレッドを開始したり、別のスレッドに返信することもできます。
message [必須]:
コメントのテキスト。
handle [オプション、デフォルト = アプリケーションキーの所有者]:
コメントを作成しているユーザーのハンドル。
related_event_id [オプション、デフォルト = None]:
返信対象の別のコメントまたはイベントの ID。
POST /v1/comments
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Start a new discussion.
# Include a handle like this
api.Comment.create(
handle='matt@example.com',
message='Should we use COBOL or Fortran!'
)
# Or set it to None
# and the handle defaults
# to the owner of the application key
api.Comment.create(message='Should we use COBOL or Fortran?')
# Reply to a discussion.
api.Comment.create(
handle='joe@example.com',
message='Smalltalk?',
related_event_id=1234
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Make a comment.
dog.comment("I have something to say.")api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"message" : "There is a problem with the database."
}' \
"https://api.datadoghq.com/api/v1/comments?api_key=${api_key}&application_key=${app_key}"{
'comment': {
'handle': 'matt@example.com',
'id': 2603645287324504065,
'message': 'Should we use COBOL or Fortran?',
'resource': '/api/v1/comments/2603645287324504065',
'url': '/event/jump_to?event_id=2603645287324504065'
}
}
["200", {
"comment" => {
"url" => "/event/jump_to?event_id=1382579089039712607",
"resource" => "/api/v1/comments/1382579089039712607",
"message" => "I have something to say.",
"handle" => "mattp+org-carlotest141@datadoghq.com",
"id" => 1382579089039712607
}
}]{
"comment": {
"handle": "mattp+org-carlotest141@datadoghq.com",
"id": 1382561676571697516,
"message": "There is a problem with the database.",
"resource": "/api/v1/comments/1382561676571697516",
"url": "/event/jump_to?event_id=1382561676571697516"
}
}message [オプション、デフォルト = 元の message]:
コメントのテキスト。
handle [オプション、デフォルト = アプリケーションキーの所有者]:
コメントを作成しているユーザーのハンドル。
PUT /v1/comments/<COMMENT_ID>
from datadog import initialize, api
from time import sleep
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Edit a comment.
newcomment = api.Comment.create(
message='Should we use COBOL or Fortran or Widgets?'
)
sleep(1)
api.Comment.update(
newcomment['comment']['id'],
message='I think differently now!'
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
comment_id = "1382579089039712607"
dog = Dogapi::Client.new(api_key, app_key)
# Update a comment.
dog.update_comment(comment_id, :message => "I've changed my mind again")api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
comment_id=<COMMENT_ID>
# Create a comment to edit. Use jq (http://stedolan.github.io/jq/download/) to get the comment id.
comment_id=$(curl -X POST -H "Content-type: application/json" -d '{"message" : "This comment was submitted and will be edited by the api."}' "https://api.datadoghq.com/api/v1/comments?api_key=${api_key}&application_key=${app_key}" | jq -r '.comment.resource|ltrimstr("/api/v1/comments/")')
curl -X PUT -H "Content-type: application/json" \
-d '{
"message" : "Actually, I am changing my mind."
}' \
"https://api.datadoghq.com/api/v1/comments/${comment_id}?api_key=${api_key}&application_key=${app_key}"
{
'comment': {
'handle': 'matt@example.com',
'id': 2603645287324504065,
'message': 'I think differently now.',
'resource': '/api/v1/comments/2603645287324504065',
'url': '/event/jump_to?event_id=2603645287324504065'
}
}
["200", {
"comment" => {
"url" => "/event/jump_to?event_id=1382579089039712607",
"resource" => "/api/v1/comments/1382579089039712607",
"message" => "I've changed my mind again",
"handle" => "mattp+org-carlotest141@datadoghq.com",
"id" => 1382579089039712607
}
}]{
"comment": {
"handle": "mattp+org-carlotest141@datadoghq.com",
"id": 1382557387240472966,
"message": "Actually, I am changing my mind.",
"resource": "/api/v1/comments/1382557387240472966",
"url": "/event/jump_to?event_id=1382557387240472966"
}
}このエンドポイントを使用すると、ダッシュボードをプログラムで作成、更新、削除、およびクエリできます。
title [必須]:
ダッシュボードのタイトル。widgets [必須]:
ダッシュボードに表示するウィジェットのリスト。ウィジェットの定義は、次の形式に従います。definition [必須]:
ウィジェットの定義。id [オプション、デフォルト=自動生成された整数]:
ウィジェットの ID。layout_type [必須]:
ダッシュボードのレイアウトタイプ。使用可能な値: ordered (以前の Timeboard) または free (以前の Screenboard レイアウト)description [オプション、デフォルト = None]:
ダッシュボードの説明。is_read_only [オプション、デフォルト = False]:
このダッシュボードが読み取り専用かどうか。True の場合は、作成者と管理者だけがダッシュボードに変更を加えることができます。notify_list [オプション、デフォルト = None]:
このダッシュボードに変更が加えられたときに通知するユーザーのハンドルのリスト。template_variables [オプション、デフォルト = None]:
このダッシュボードのテンプレート変数のリスト。テンプレート変数の定義は、次の形式に従います。name [必須]:
変数の名前。default [オプション、デフォルト = None]:
ダッシュボード読み込み時のテンプレート変数のデフォルト値。prefix [オプション、デフォルト = None]:
変数に関連付けられるタグプレフィックス。このプレフィックスを持つタグだけが変数ドロップダウンに表示されます。POST /v1/dashboard
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
title = 'Average Memory Free Shell'
widgets = [{
'definition': {
'type': 'timeseries',
'requests': [
{'q': 'avg:system.mem.free{*}'}
],
'title': 'Average Memory Free'
}
}]
layout_type = 'ordered'
description = 'A dashboard with memory info.'
is_read_only = True
notify_list = ['user@domain.com']
template_variables = [{
'name': 'host1',
'prefix': 'host',
'default': 'my-host'
}]
api.Dashboard.create(title=title,
widgets=widgets,
layout_type=layout_type,
description=description,
is_read_only=is_read_only,
notify_list=notify_list,
template_variables=template_variables)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Create a dashboard.
title = 'Average Memory Free Shell'
widgets = [{
'definition': {
'type' => 'timeseries',
'requests' => [
{'q' => 'avg:system.mem.free{*}'}
],
'title' => 'Average Memory Free'
}
}]
layout_type = 'ordered'
description = 'A dashboard with memory info.'
is_read_only = true
notify_list = ['user@domain.com']
template_variables = [{
'name' => 'host1',
'prefix' => 'host',
'default' => 'my-host'
}]
dog.create_board(title, widgets, layout_type, {
'description' => description,
'is_read_only' => is_read_only,
'notify_list' => notify_list,
'template_variables' => template_variables
})
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"title" : "Average Memory Free Shell",
"widgets" : [{
"definition": {
"type": "timeseries",
"requests": [
{"q": "avg:system.mem.free{*}"}
],
"title": "Average Memory Free"
}
}],
"layout_type": "ordered",
"description" : "A dashboard with memory info.",
"is_read_only": true,
"notify_list": ["user@domain.com"],
"template_variables": [{
"name": "host1",
"prefix": "host",
"default": "my-host"
}]
}' \
"https://api.datadoghq.com/api/v1/dashboard?api_key=${api_key}&application_key=${app_key}"
{
'notify_list':[
'user@domain.com'
],
'description':'A dashboard with memory info.',
'template_variables':[
{
'default':'my-host',
'prefix':'host',
'name':'host1'
}
],
'is_read_only':True,
'id':'qc9-tuk-9kv',
'title':'Average Memory Free Shell',
'url':'/dashboard/qc9-tuk-9kv/average-memory-free-shell',
'created_at':'2019-02-05T01:20:56.323548+00:00',
'modified_at':'2019-02-05T01:20:56.323548+00:00',
'author_handle':'user@domain.com',
'widgets':[
{
'definition':{
'requests':[
{
'q':'avg:system.mem.free{*}'
}
],
'type':'timeseries',
'title':'Average Memory Free'
},
'id':2252428653625902
}
],
'layout_type':'ordered'
}
[
"200",
{
"notify_list" => ["user@domain.com"],
"description" => nil,
"template_variables" => nil,
"is_read_only" => true,
"id" => "qc9-tuk-9kv",
"title" => "Average Memory Free Shell",
"url" => "/dashboard/qc9-tuk-9kv/average-memory-free-shell",
"created_at" => "2019-02-05T01:35:46.388000+00:00",
"modified_at" => "2019-02-05T01:35:46.388000+00:00",
"author_handle" => "user@domain.com",
"widgets" => [
{
"definition" => {
"requests" => [
{ "q" => "avg:system.mem.free{*}"}
],
"type" => "timeseries",
"title" => "Average Memory Free"
},
"id" => 2252428653625902
}
],
"layout_type" => "ordered"
}
]
{
"notify_list": [
"user@domain.com"
],
"description": "A dashboard with memory info.",
"template_variables": [
{
"default": "my-host",
"prefix": "host",
"name": "host1"
}
],
"is_read_only": true,
"id": "qc9-tuk-9kv",
"title": "Average Memory Free Shell",
"url": "/dashboard/qc9-tuk-9kv/average-memory-free-shell",
"created_at": "2019-02-05T01:06:36.636295+00:00",
"modified_at": "2019-02-05T01:06:36.636295+00:00",
"author_handle": "user@domain.com",
"widgets": [
{
"definition": {
"requests": [
{
"q": "avg:system.mem.free{*}"
}
],
"type": "timeseries",
"title": "Average Memory Free"
},
"id": 2252428653625902
}
],
"layout_type": "ordered"
}
title [必須]:
ダッシュボードのタイトル。widgets [必須]:
ダッシュボードに表示するウィジェットのリスト。ウィジェットの定義は、次の形式に従います。definition [必須]:
ウィジェットの定義。id [オプション、デフォルト=自動生成された整数]:
ウィジェットの ID。layout_type [必須]:
ダッシュボードのレイアウトタイプ。使用可能な値: ordered (以前の Timeboard) または free (以前の Screenboard レイアウト)description [オプション、デフォルト = None]:
ダッシュボードの説明。is_read_only [オプション、デフォルト = False]:
このダッシュボードが読み取り専用かどうか。True の場合は、作成者と管理者だけがダッシュボードに変更を加えることができます。notify_list [オプション、デフォルト = None]:
このダッシュボードに変更が加えられたときに通知するユーザーのハンドルのリスト。template_variables [オプション、デフォルト = None]:
このダッシュボードのテンプレート変数のリスト。テンプレート変数の定義は、次の形式に従います。name [必須]:
変数の名前。default [オプション、デフォルト = None]:
ダッシュボード読み込み時のテンプレート変数のデフォルト値。prefix [オプション、デフォルト = None]:
変数に関連付けられるタグプレフィックス。このプレフィックスを持つタグだけが変数ドロップダウンに表示されます。PUT /v1/dashboard/<DASHBOARD_ID>
from datadog import initialize, api
options = {'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'}
initialize(**options)
dashboard_id = '<DASHBOARD_ID>'
title = 'Sum of Memory Free'
widgets = [{
'definition': {
'type': 'timeseries',
'requests': [
{'q': 'sum:system.mem.free{*}'}
],
'title': 'Sum Memory Free Shell'
}
}]
layout_type = 'ordered'
description = 'An updated dashboard with memory info.'
is_read_only = True
notify_list = ['user@domain.com']
template_variables = [{
'name': 'host1',
'prefix': 'host',
'default': 'my-host'
}]
api.Dashboard.update(dashboard_id,
title=title,
widgets=widgets,
layout_type=layout_type,
description=description,
is_read_only=is_read_only,
notify_list=notify_list,
template_variables=template_variables)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dashboard_id = '<DASHBOARD_ID>'
title = 'Sum of Memory Free'
widgets = [{
'definition': {
'type' => 'timeseries',
'requests' => [
{'q' => 'sum:system.mem.free{*}'}
],
'title' => 'Sum Memory Free Shell'
}
}]
layout_type = 'ordered'
description = 'An updated dashboard with memory info.'
is_read_only = true
notify_list = ['user@domain.com']
template_variables = [{
'name' => 'host1',
'prefix' => 'host',
'default' => 'my-host'
}]
dog.update_board(dashboard_id, title, widgets, layout_type, {
'description' => description,
'is_read_only' => is_read_only,
'notify_list' => notify_list,
'template_variables' => template_variables
})
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
dashboard_id="<DASHBOARD_ID>"
curl -X PUT -H "Content-type: application/json" \
-d '{
"title" : "Sum of Memory Free",
"widgets" : [{
"definition": {
"type": "timeseries",
"requests": [
{"q": "sum:system.mem.free{*}"}
],
"title": "Sum Memory Free Shell"
}
}],
"layout_type": "ordered",
"description" : "An updated dashboard with memory info.",
"is_read_only": true,
"notify_list": ["user@domain.com"],
"template_variables": [{
"name": "host1",
"prefix": "host",
"default": "my-host"
}]
}' \
"https://api.datadoghq.com/api/v1/dashboard/${dashboard_id}?api_key=${api_key}&application_key=${app_key}"
{
'notify_list':[
'user@domain.com'
],
'description':'An updated dashboard with memory info.',
'template_variables':[
{
'default':'my-host',
'prefix':'host',
'name':'host1'
}
],
'is_read_only':True,
'id':'qc9-tuk-9kv',
'title':'Sum of Memory Free',
'url':'/dashboard/qc9-tuk-9kv/sum-of-memory-free',
'created_at':'2019-02-05T01:06:36.636295+00:00',
'modified_at':'2019-02-05T02:14:15.769022+00:00',
'author_handle':'user@domain.com',
'widgets':[
{
'definition':{
'requests':[
{
'q':'sum:system.mem.free{*}'
}
],
'type':'timeseries',
'title':'Sum Memory Free Shell'
},
'id':6744688099018785
}
],
'layout_type':'ordered'
}
[
"200",
{
"notify_list" => ["user@domain.com"],
"description" => nil,
"template_variables" => nil,
"is_read_only" => false,
"id" => "qc9-tuk-9kv",
"title" => "Sum of Memory Free",
"url" => "/dashboard/qc9-tuk-9kv/sum-of-memory-free",
"created_at" => "2019-02-05T01:06:36.636295+00:00",
"modified_at" => "2019-02-05T02:19:06.792555+00:00",
"author_handle" => "user@domain.com",
"widgets" => [
{
"definition" => {
"requests" => [
{
"q" => "sum:system.mem.free{*}"
}
],
"type" => "timeseries",
"title" => "Sum Memory Free Shell"
},
"id" => 7763291144447019
}
],
"layout_type" => "ordered"
}
]
{
"notify_list": ["user@domain.com"],
"description": "An updated dashboard with memory info.",
"template_variables": [
{
"default": "my-host",
"prefix": "host",
"name": "host1"
}
],
"is_read_only": true,
"id": "qc9-tuk-9kv",
"title": "Sum of Memory Free",
"url": "/dashboard/qc9-tuk-9kv/sum-of-memory-free",
"created_at": "2019-02-05T01:06:36.636295+00:00",
"modified_at": "2019-02-05T02:08:57.399410+00:00",
"author_handle": "user@domain.com",
"widgets": [
{
"definition": {
"requests": [
{
"q": "sum:system.mem.free{*}"
}
],
"type": "timeseries",
"title": "Sum Memory Free Shell"
},
"id": 6979333833881176
}
],
"layout_type": "ordered"
}
既存のダッシュボードを削除します。
このエンドポイントは、JSON 引数を受け取りません。
DELETE /v1/dashboard/<DASHBOARD_ID>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
dashboard_id = '<DASHBOARD_ID>'
api.Dashboard.delete(dashboard_id)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dashboard_id = '<DASHBOARD_ID>'
dog.delete_board(dashboard_id)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
dashboard_id="<DASHBOARD_ID>"
curl -X DELETE "https://api.datadoghq.com/api/v1/dashboard/${dashboard_id}?api_key=${api_key}&application_key=${app_key}"
{
'deleted_dashboard_id': 'qc9-tuk-9kv'
}
["200", {"deleted_dashboard_id" => "qc9-tuk-9kv"}]
{
"deleted_dashboard_id": "qc9-tuk-9kv"
}
既存のダッシュボードの定義を取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/dashboard/<DASHBOARD_ID>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
dashboard_id = '<DASHBOARD_ID>'
api.Dashboard.get(dashboard_id)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dashboard_id = '<DASHBOARD_ID>'
dog.get_board(dashboard_id)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
dashboard_id="<DASHBOARD_ID>"
curl "https://api.datadoghq.com/api/v1/dashboard/${dashboard_id}?api_key=${api_key}&application_key=${app_key}"
{
'notify_list':[
'user@domain.com'
],
'description':'A dashboard with memory info.',
'template_variables':[
{
'default':'my-host',
'prefix':'host',
'name':'host1'
}
],
'is_read_only':True,
'id':'qc9-tuk-9kv',
'title':'Average Memory Free Shell',
'url':'/dashboard/qc9-tuk-9kv/average-memory-free-shell',
'created_at':'2019-02-05T01:20:56.323548+00:00',
'modified_at':'2019-02-05T01:20:56.323548+00:00',
'author_handle':'user@domain.com',
'widgets':[
{
'definition':{
'requests':[
{
'q':'avg:system.mem.free{*}'
}
],
'type':'timeseries',
'title':'Average Memory Free'
},
'id':2252428653625902
}
],
'layout_type':'ordered'
}
{
"notify_list": [
"user@domain.com"
],
"description": "A dashboard with memory info.",
"template_variables": [
{
"default": "my-host",
"prefix": "host",
"name": "host1"
}
],
"is_read_only": true,
"id": "qc9-tuk-9kv",
"title": "Average Memory Free Shell",
"url": "/dashboard/qc9-tuk-9kv/average-memory-free-shell",
"created_at": "2019-02-05T01:06:36.636295+00:00",
"modified_at": "2019-02-05T01:06:36.636295+00:00",
"author_handle": "user@domain.com",
"widgets": [
{
"definition": {
"requests": [
{
"q": "avg:system.mem.free{*}"
}
],
"type": "timeseries",
"title": "Average Memory Free"
},
"id": 2252428653625902
}
],
"layout_type": "ordered"
}
{
"notify_list": [
"user@domain.com"
],
"description": "A dashboard with memory info.",
"template_variables": [
{
"default": "my-host",
"prefix": "host",
"name": "host1"
}
],
"is_read_only": true,
"id": "qc9-tuk-9kv",
"title": "Average Memory Free Shell",
"url": "/dashboard/qc9-tuk-9kv/average-memory-free-shell",
"created_at": "2019-02-05T01:06:36.636295+00:00",
"modified_at": "2019-02-05T01:06:36.636295+00:00",
"author_handle": "user@domain.com",
"widgets": [
{
"definition": {
"requests": [
{
"q": "avg:system.mem.free{*}"
}
],
"type": "timeseries",
"title": "Average Memory Free"
},
"id": 2252428653625902
}
],
"layout_type": "ordered"
}
すべてのダッシュボードを取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/dashboard
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.Dashboard.get_all()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.get_all_boards()
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl "https://api.datadoghq.com/api/v1/dashboard?api_key=${api_key}&application_key=${app_key}"
{
'dashboards': [{
'created_at': '2019-02-28T17:12:59.327729+00:00',
'is_read_only': False,
'description': 'My Screenboard Description',
'title': 'My Screenboard',
'url': '/dashboard/grh-zkj-h2c/my-screenboard',
'layout_type': 'free',
'modified_at': '2019-03-13T19:09:40.930616+00:00',
'author_handle':'user@domain.com',
'id': 'grh-zkj-h2c'
},
{
'created_at': '2019-02-28T17:45:11.535045+00:00',
'is_read_only': False,
'description': 'My Timeboard Description',
'title': 'My Timeboard',
'url': '/dashboard/4qf-77b-uhc/my-timeboard',
'layout_type': 'ordered',
'modified_at': '2019-03-11T14:22:03.131495+00:00',
'author_handle':'user@domain.com',
'id': '4qf-77b-uhc'
}
]
}
{
"dashboards": [{
"created_at" => "2019-02-28T17:12:59.327729+00:00",
"is_read_only" => false,
"description" => "My Screenboard Description",
"title" => "My Screenboard",
"url" => "/dashboard/grh-zkj-h2c/my-screenboard",
"layout_type" => "free",
"modified_at" => "2019-03-13T19:09:40.930616+00:00",
"author_handle": "user@domain.com",
"id" => "grh-zkj-h2c"
}, {
"created_at" => "2019-02-28T17:45:11.535045+00:00",
"is_read_only" => false,
"description" => "My Timeboard Description",
"title" => "My Timeboard",
"url" => "/dashboard/4qf-77b-uhc/my-timeboard",
"layout_type" => "ordered",
"modified_at" => "2019-03-11T14:22:03.131495+00:00",
"author_handle": "user@domain.com",
"id" => "4qf-77b-uhc"
}]
}
{
"dashboards": [{
"created_at": "2019-02-28T17:12:59.327729+00:00",
"is_read_only": false,
"description": "My Screenboard Description",
"title": "My Screenboard",
"url": "/dashboard/grh-zkj-h2c/my-screenboard",
"layout_type": "free",
"modified_at": "2019-03-13T19:09:40.930616+00:00",
"author_handle": "user@domain.com",
"id": "grh-zkj-h2c"
},
{
"created_at": "2019-02-28T17:45:11.535045+00:00",
"is_read_only": false,
"description": "My Timeboard Description",
"title": "My Timeboard",
"url": "/dashboard/4qf-77b-uhc/my-timeboard",
"layout_type": "ordered",
"modified_at": "2019-03-11T14:22:03.131495+00:00",
"author_handle": "user@domain.com",
"id": "4qf-77b-uhc"
}
]
}
APIを介してすべてのダッシュボードを簡単に整理、検索、およびチームや組織と共有できます。
既存のダッシュボードリストの定義を取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/dashboard/lists/manual/<LIST_ID>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.DashboardList.get(4741)require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.get_dashboard_list(4741)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X GET \
"https://api.datadoghq.com/api/v1/dashboard/lists/manual/${list_id}?api_key=${api_key}&application_key=${app_key}"{
'name': 'My Dashboard List',
'created': '2018-03-16T09:44:41.476018+00:00',
'author': {
'handle': 'test1@datadoghq.com',
'name': 'Author Name'
},
'dashboards': None,
'modified': '2018-03-16T09:44:41.476030+00:00',
'is_favorite': False,
'dashboard_count': 0,
'type': 'manual_dashboard_list',
'id': 4741
}[
"200",
{
"is_favorite" => false,
"name" => "My Dashboard List",
"dashboard_count" => 0,
"author" => {
"handle" => "test1@datadoghq.com",
"name" => "Author Name"
},
"created" => "2018-03-16T09:44:41.476018+00:00",
"type" => "manual_dashboard_list",
"dashboards" => nil,
"modified" => "2018-03-16T09:44:41.476030+00:00",
"id" => 4741
}
]{
"name": "My Dashboard List",
"created": "2018-03-16T09:44:41.476018+00:00",
"author": {
"handle": "test1@datadoghq.com",
"name": "Author Name"
},
"dashboards": None,
"modified": "2018-03-16T09:44:41.476030+00:00",
"is_favorite": False,
"dashboard_count": 0,
"type": "manual_dashboard_list",
"id": 4741
}Fetch all of your existing dashboard list definitions.
This endpoint takes no JSON arguments.
GET /v1/dashboard/lists/manual
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.DashboardList.get_all()require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.get_all_dashboard_lists()api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X GET \
"https://api.datadoghq.com/api/v1/dashboard/lists/manual?api_key=${api_key}&application_key=${app_key}"{
'dashboard_lists': [
{
'name': 'My Dashboard List B',
'created': '2017-09-14T14:59:59.040891+00:00',
'author': {
'handle': 'test1@datadoghq.com',
'name': 'Author Name'
},
'dashboards': None,
'modified': '2018-03-16T13:03:52.698416+00:00',
'is_favorite': True,
'dashboard_count': 22,
'type': 'manual_dashboard_list',
'id': 142
},
{
'name': 'My Dashboard List A',
'created': '2017-11-17T11:17:43.273931+00:00',
'author': {
'handle': 'test2@datadoghq.com',
'name': 'Other Author Name'
},
'dashboards': None,
'modified': '2018-03-16T13:03:43.835281+00:00',
'is_favorite': False,
'dashboard_count': 12,
'type': 'manual_dashboard_list',
'id': 295
}
]
}[
"200",
{
"dashboard_lists" => [
{
"is_favorite" => true,
"name" => "My Dashboard List B",
"dashboard_count" => 22,
"author" => {
"handle" => "test1@datadoghq.com",
"name" => "Author Name"
},
"created" => "2017-09-14T14:59:59.040891+00:00",
"type" => "manual_dashboard_list",
"dashboards" => nil,
"modified" => "2018-03-16T13:03:52.698416+00:00",
"id" => 142
},
{
"is_favorite" => false,
"name" => "My Dashboard List A",
"dashboard_count" => 12,
"author" => {
"handle" => "test2@datadoghq.com",
"name" => "Other Author Name"
},
"created" => "2017-11-17T11:17:43.273931+00:00",
"type" => "manual_dashboard_list",
"dashboards" => nil,
"modified" => "2018-03-16T13:03:43.835281+00:00",
"id" => 295
}
]
}
]{
"dashboard_lists": [
{
"name": "My Dashboard List B",
"created": "2017-09-14T14:59:59.040891+00:00",
"author": {
"handle": "test1@datadoghq.com",
"name": "Author Name"
},
"dashboards": None,
"modified": "2018-03-16T13:03:52.698416+00:00",
"is_favorite": True,
"dashboard_count": 22,
"type": "manual_dashboard_list",
"id": 142
},
{
"name": "My Dashboard List A",
"created": "2017-11-17T11:17:43.273931+00:00",
"author": {
"handle": "test2@datadoghq.com",
"name": "Other Author Name"
},
"dashboards": None,
"modified": "2018-03-16T13:03:43.835281+00:00",
"is_favorite": False,
"dashboard_count": 12,
"type": "manual_dashboard_list",
"id": 295
}
]
}Create an empty dashboard list.
name [required]:
The name of the dashboard list.POST /v1/dashboard/lists/manual
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
name = 'My Dashboard List'
api.DashboardList.create(name=name)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
name = 'My Dashboard List'
result = dog.create_dashboard_list(name)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"name": "My Dashboard List"
}' \
"https://api.datadoghq.com/api/v1/dashboard/lists/manual?api_key=${api_key}&application_key=${app_key}"{
'name': 'My Dashboard List',
'created': '2018-03-16T09:44:41.476018+00:00',
'author': {
'handle': 'test1@datadoghq.com',
'name': 'Author Name'
},
'dashboards': None,
'modified': '2018-03-16T09:44:41.476030+00:00',
'is_favorite': False,
'dashboard_count': 0,
'type': 'manual_dashboard_list',
'id': 4741
}[
"200",
{
"is_favorite" => false,
"name" => "My Dashboard List",
"dashboard_count" => 0,
"author" => {
"handle" => "test1@datadoghq.com",
"name" => "Author Name"
},
"created" => "2018-03-16T09:51:47.905261+00:00",
"type" => "manual_dashboard_list",
"dashboards" => nil,
"modified" => "2018-03-16T09:51:47.905273+00:00",
"id" => 4741
}
]{
"name": "My Dashboard List",
"created": "2018-03-16T09:44:41.476018+00:00",
"author": {
"handle": "test1@datadoghq.com",
"name": "Author Name"
},
"dashboards": None,
"modified": "2018-03-16T09:44:41.476030+00:00",
"is_favorite": False,
"dashboard_count": 0,
"type": "manual_dashboard_list",
"id": 4741
}Update the name of a dashboard list
name [required]:
The name of the dashboard list.PUT /v1/dashboard/lists/manual/<LIST_ID>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
list_id = 4741
name = 'My Updated Dashboard List'
api.DashboardList.update(list_id, name=name)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
list_id = 4741
name = 'My Updated Dashboard List'
result = dog.update_dashboard_list(list_id, name)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X PUT -H "Content-type: application/json" \
-d '{
"name": "My Updated Dashboard List"
}' \
"https://api.datadoghq.com/api/v1/dashboard/lists/manual/${list_id}?api_key=${api_key}&application_key=${app_key}"
{
'name': 'My Updated Dashboard List',
'created': '2018-03-16T09:44:41.476018+00:00',
'author': {
'handle': 'test1@datadoghq.com',
'name': 'Author Name'
},
'dashboards': None,
'modified': '2018-03-16T13:45:42.288026+00:00',
'is_favorite': False,
'dashboard_count': 5,
'type': 'manual_dashboard_list',
'id': 4741
}[
"200",
{
"is_favorite" => false,
"name" => "My Updated Dashboard List",
"dashboard_count" => 5,
"author" => {
"handle" => "test1@datadoghq.com",
"name" => "Author Name"
},
"created" => "2018-03-16T09:44:41.476018+00:00",
"type" => "manual_dashboard_list",
"dashboards" => nil,
"modified" => "2018-03-16T13:45:42.288026+00:00",
"id" => 4741
}
]{
"name": "My Updated Dashboard List",
"created": "2018-03-16T09:44:41.476018+00:00",
"author": {
"handle": "test1@datadoghq.com",
"name": "Author Name"
},
"dashboards": None,
"modified": "2018-03-16T13:45:42.288026+00:00",
"is_favorite": False,
"dashboard_count": 5,
"type": "manual_dashboard_list",
"id": 4741
}Delete an existing dashboard list.
This endpoint takes no JSON arguments.
DELETE /v1/dashboard/lists/manual/<LIST_ID>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.DashboardList.delete(4741)require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.delete_dashboard_list(4741)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X DELETE \
"https://api.datadoghq.com/api/v1/dashboard/lists/manual/${list_id}?api_key=${api_key}&application_key=${app_key}"{
'deleted_dashboard_list_id': 4741
}[
"200",
{
"deleted_dashboard_list_id" => 4741
}
]{
"deleted_dashboard_list_id": 4741
}Fetch the dashboard list’s dashboard definitions.
This endpoint takes no JSON arguments.
GET /v2/dashboard/lists/manual/<LIST_ID>/dashboards
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.DashboardList.v2.get_items(4741)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.v2.get_items_of_dashboard_list(4741)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X GET \
"https://api.datadoghq.com/api/v2/dashboard/lists/manual/${list_id}/dashboards?api_key=${api_key}&application_key=${app_key}"
{
'total': 5,
'dashboards': [
{
'popularity': 0,
'is_shared': False,
'author': {
'handle': None,
'name': None
},
'url': '/screen/integration/87/aws-dynamodb',
'title': 'AWS DynamoDB',
'modified': None,
'created': None,
'is_favorite': True,
'is_read_only': True,
'type': 'integration_screenboard',
'id': '87',
'icon': '/static/v/34.254868/images/saas_logos/small/amazon_dynamodb.png'
},
{
'popularity': 0,
'is_shared': False,
'author': {
'handle': None,
'name': None
},
'url': '/dash/integration/23/postgres---metrics',
'title': 'Postgres - Metrics',
'modified': None,
'created': None,
'is_favorite': True,
'is_read_only': True,
'type': 'integration_timeboard',
'id': '23',
'icon': '/static/v/34.254868/images/saas_logos/small/postgres.png'
},
{
'popularity': 0,
'is_shared': False,
'author': {
'handle': 'test1@datadoghq.com',
'name': 'Author Name'
},
'url': '/dash/qts-q2k-yq6/trace-api',
'title': 'Trace API',
'modified': '2018-03-16T13:39:39.517133+00:00',
'created': '2015-10-21T13:22:48.633391+00:00',
'is_favorite': False,
'is_read_only': False,
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6',
'icon': None
},
{
'popularity': 0,
'is_shared': False,
'author': {
'handle': 'test2@datadoghq.com',
'name': 'Other Author Name'
},
'url': '/screen/rys-xwq-geh/agent-stats',
'title': 'Agent Stats',
'modified': '2018-03-16T12:54:25.968134+00:00',
'created': '2014-06-18T18:19:00.974763+00:00',
'is_favorite': False,
'is_read_only': False,
'type': 'custom_screenboard',
'id': 'rys-xwq-geh',
'icon': None
},
{
'popularity': 0,
'is_shared': False,
'author': {
'handle': None,
'name': None
},
'url': '/dash/host/3245468',
'title': 'agent-gui',
'modified': None,
'created': None,
'is_favorite': False,
'is_read_only': True,
'type': 'host_timeboard',
'id': '3245468',
'icon': None
}
]
}
[
"200",
{
"total" => 5,
"dashboards" => [
{
"popularity" => 0,
"title" => "AWS DynamoDB",
"is_favorite" => true,
"id" => "87",
"icon" => "/static/v/34.254868/images/saas_logos/small/amazon_dynamodb.png",
"is_shared" => false,
"author" => {
"handle" => nil,
"name" => nil
},
"url" => "/screen/integration/87/aws-dynamodb",
"created" => nil,
"modified" => nil,
"is_read_only" => true,
"type" => "integration_screenboard"
},
{
"popularity" => 0,
"title" => "Postgres - Metrics",
"is_favorite" => true,
"id" => "23",
"icon" => "/static/v/34.254868/images/saas_logos/small/postgres.png",
"is_shared" => false,
"author" => {
"handle" => nil,
"name" => nil
},
"url" => "/dash/integration/23/postgres---metrics",
"created" => nil,
"modified" => nil,
"is_read_only" => true,
"type" => "integration_timeboard"
},
{
"popularity" => 0,
"title" => "Trace API",
"is_favorite" => false,
"id" => "qts-q2k-yq6",
"icon" => nil,
"is_shared" => false,
"author" => {
"handle" => "test1@datadoghq.com",
"name" => "Author Name"
},
"url" => "/dash/qts-q2k-yq6/trace-api",
"created" => "2015-10-21T13:22:48.633391+00:00",
"modified" => "2018-03-16T13:39:39.517133+00:00",
"is_read_only" => false,
"type" => "custom_timeboard"
},
{
"popularity" => 0,
"title" => "Agent Stats",
"is_favorite" => false,
"id" => "rys-xwq-geh",
"icon" => nil,
"is_shared" => false,
"author" => {
"handle" => "test2@datadoghq.com",
"name" => "Other Author Name"
},
"url" => "/screen/rys-xwq-geh/agent-stats",
"created" => "2014-06-18T18:19:00.974763+00:00",
"modified" => "2018-03-16T12:54:25.968134+00:00",
"is_read_only" => false,
"type" => "custom_screenboard"
},
{
"popularity" => 0,
"title" => "agent-gui",
"is_favorite" => false,
"id" => "3245468",
"icon" => nil,
"is_shared" => false,
"author" => {
"handle" => nil,
"name" => nil
},
"url" => "/dash/host/3245468",
"created" => nil,
"modified" => nil,
"is_read_only" => true,
"type" => "host_timeboard"
}
]
}
]
{
"total": 5,
"dashboards": [
{
"popularity": 0,
"is_shared": False,
"author": {
"handle": None,
"name": None
},
"url": "/screen/integration/87/aws-dynamodb",
"title": "AWS DynamoDB",
"modified": None,
"created": None,
"is_favorite": True,
"is_read_only": True,
"type": "integration_screenboard",
"id": "87",
"icon": "/static/v/34.254868/images/saas_logos/small/amazon_dynamodb.png"
},
{
"popularity": 0,
"is_shared": False,
"author": {
"handle": None,
"name": None
},
"url": "/dash/integration/23/postgres---metrics",
"title": "Postgres - Metrics",
"modified": None,
"created": None,
"is_favorite": True,
"is_read_only": True,
"type": "integration_timeboard",
"id": "23",
"icon": "/static/v/34.254868/images/saas_logos/small/postgres.png"
},
{
"popularity": 0,
"is_shared": False,
"author": {
"handle": "test1@datadoghq.com",
"name": "Author Name"
},
"url": "/dash/qts-q2k-yq6/trace-api",
"title": "Trace API",
"modified": "2018-03-16T13:39:39.517133+00:00",
"created": "2015-10-21T13:22:48.633391+00:00",
"is_favorite": False,
"is_read_only": False,
"type": "custom_timeboard",
"id": "qts-q2k-yq6",
"icon": None
},
{
"popularity": 0,
"is_shared": False,
"author": {
"handle": "test2@datadoghq.com",
"name": "Other Author Name"
},
"url": "/screen/rys-xwq-geh/agent-stats",
"title": "Agent Stats",
"modified": "2018-03-16T12:54:25.968134+00:00",
"created": "2014-06-18T18:19:00.974763+00:00",
"is_favorite": False,
"is_read_only": False,
"type": "custom_screenboard",
"id": "rys-xwq-geh",
"icon": None
},
{
"popularity": 0,
"is_shared": False,
"author": {
"handle": None,
"name": None
},
"url": "/dash/host/3245468",
"title": "agent-gui",
"modified": None,
"created": None,
"is_favorite": False,
"is_read_only": True,
"type": "host_timeboard",
"id": "3245468",
"icon": None
}
]
}
既存のダッシュボードリストにダッシュボードを追加します。
dashboards [必須]:
リストに追加するダッシュボードのリスト。
ダッシュボードの定義は、次の形式に従います。
type [必須]:
ダッシュボードのタイプ。
以下のいずれかでなければなりません。
"custom_timeboard""custom_screenboard""integration_screenboard""integration_timeboard""host_timeboard"id [必須]:
ダッシュボードの ID。
POST /v2/dashboard/lists/manual/<LIST_ID>/dashboards
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
list_id = 4741
dashboards = [
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
api.DashboardList.v2.add_items(list_id, dashboards=dashboards)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
list_id = 4741
dashboards = [
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
result = dog.v2.add_items_to_dashboard_list(list_id, dashboards)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X POST -H "Content-type: application/json" \
-d '{
"dashboards": [
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}' \
"https://api.datadoghq.com/api/v2/dashboard/lists/manual/${list_id}/dashboards?api_key=${api_key}&application_key=${app_key}"
{
'added_dashboards_to_list': [
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
}
[
"200",
{
"added_dashboards_to_list" => [
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
}
]
{
"added_dashboards_to_list": [
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}
Update dashboards of an existing dashboard list.
dashboards [required]:
The new list of dashboards for the dashboard list.
Dashboard definitions follow this form:
type [required]:
The type of the dashboard.
The type must be one of:
"custom_timeboard""custom_screenboard""integration_screenboard""integration_timeboard""host_timeboard"id [required]:
The id of the dashboard.
PUT /v2/dashboard/lists/manual/<LIST_ID>/dashboards
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
list_id = 4741
dashboards = [
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
api.DashboardList.v2.update_items(list_id, dashboards=dashboards)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
list_id = 4741
dashboards = [
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
result = dog.v2.update_items_of_dashboard_list(list_id, dashboards)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X PUT -H "Content-type: application/json" \
-d '{
"dashboards": [
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}' \
"https://api.datadoghq.com/api/v2/dashboard/lists/manual/${list_id}/dashboards?api_key=${api_key}&application_key=${app_key}"
{
'dashboards': [
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
}
[
"200",
{
"dashboards" => [
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
}
]
{
"dashboards": [
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}
Delete dashboards from an existing dashboard list.
dashboards [required]:
A list of dashboards to remove from the list.
Dashboard definitions follow this form:
type [required]:
The type of the dashboard.
The type must be one of:
"custom_timeboard""custom_screenboard""integration_screenboard""integration_timeboard""host_timeboard"id [required]:
The id of the dashboard.
DELETE /v2/dashboard/lists/manual/<LIST_ID>/dashboards
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
list_id = 4741
dashboards = [
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
api.DashboardList.v2.delete_items(list_id, dashboards=dashboards)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
list_id = 4741
dashboards = [
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
result = dog.v2.delete_items_from_dashboard_list(list_id, dashboards)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X DELETE -H "Content-type: application/json" \
-d '{
"dashboards": [
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}' \
"https://api.datadoghq.com/api/v2/dashboard/lists/manual/${list_id}/dashboards?api_key=${api_key}&application_key=${app_key}"
{
'deleted_dashboards_from_list': [
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
}
[
"200",
{
"deleted_dashboards_from_list" => [
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
}
]
{
"deleted_dashboards_from_list": [
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}
ダウンタイム設定を使用すると、アラートからいくつかのスコープをグローバルに除外することができ、モニター通知をより詳細に制御できます。ダウンタイム設定は、開始時間と終了時間を指定してスケジューリングされ、指定された Datadog タグに関連するすべてのアラートの発生を抑止します。
scope [必須]:
ダウンタイムが適用されるスコープ (例: host:app2)。複数のスコープは、カンマ区切りリストで指定します (例: env:dev,env:prod)。設定されるダウンタイムは、指定されたスコープのいずれかではなく、すべて (env:dev と env:prod の両方) と一致するソースに適用されます。monitor_tags [オプション、デフォルト = モニタータグフィルターなし]:
モニタータグのカンマ区切りリスト。これは、(scope パラメーターで絞り込まれる) モニタークエリで使用されるタグではなく、ダウンタイムが適用されるモニターに直接適用されるタグです。設定されるダウンタイムは、指定されたモニタータグのいずれかではなく、すべて (service:postgres と team:frontend の両方) と一致するモニターに適用されます。monitor_id [オプション、デフォルト = None]:
ダウンタイムが適用される単一のモニター。指定しない場合、ダウンタイムはすべてのモニターに適用されます。start [オプション、デフォルト = None]:
ダウンタイムを開始する時間の POSIX タイムスタンプ。指定しない場合、ダウンタイムは作成されるとすぐに開始します。end [オプション、デフォルト = None]:
ダウンタイムを終了する時間の POSIX タイムスタンプ。指定しない場合、ダウンタイムは (取り消されるまで) 無期限に有効になります。message [オプション、デフォルト = None]:
このダウンタイムの通知に含めるメッセージ。イベントと同じ「@username」表記を使用して、特定のユーザーに電子メール通知を送信できます。timezone [オプション、デフォルト = UTC]:
ダウンタイムのタイムゾーン。recurrence [オプション、デフォルト = None]:
さまざまなパラメーターを使用してダウンタイムの繰り返しを定義するオブジェクト。type: 繰り返しのタイプ。days、weeks、months、years から選択します。period: 繰り返す頻度を整数で指定します。たとえば、3 日ごとに繰り返す場合、type は days、period は 3 を指定します。week_days: (オプション) 繰り返す曜日のリスト。Mon、Tue、Wed、Thu、Fri、Sat、Sun から選択します。type が weeks の場合にのみ適用されます。最初の文字は大文字にする必要があります。until_occurrences: (オプション) ダウンタイムを再スケジューリングする回数。until_occurences と until_date は相互に排他的です。until_date: (オプション) 繰り返しが終了する日付を指定する POSIX タイムスタンプ。until_occurences と until_date は相互に排他的です。POST /v1/downtime
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Repeat for 3 hours (starting now) on every week day for 4 weeks.
start_ts = int(time.time())
end_ts = start_ts + (3 * 60 * 60)
end_reccurrence_ts = start_ts + (4 * 7 * 24 * 60 * 60) # 4 weeks from now
recurrence = {
'type': 'weeks',
'period': 1,
'week_days': ['Mon', 'Tue', 'Wed', 'Thu', 'Fri'],
'until_date': end_reccurrence_ts
}
# Schedule downtime
api.Downtime.create(
scope='env:staging',
start=start_ts,
end=end_ts,
recurrence=recurrence
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Repeat for 3 hours(starting now) on every week day for 4 weeks.
start_ts = Time.now.to_i
end_ts = start_ts + (3 * 60 * 60)
end_reccurrence_ts = start_ts + (4 * 7 * 24 * 60 * 60)# 4 weeks from now
recurrence = {
'type' => 'weeks',
'period' => 1,
'week_days' => ['Mon', 'Tue', 'Wed', 'Thu', 'Fri'],
'until_date' => end_reccurrence_ts
}
# Schedule downtime
dog.schedule_downtime('env:testing', :start => start_ts, :end => end_ts, :recurrence => recurrence)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
start=$(date +%s)
end=$(date -v+3H +%s)
end_recurrence=$(date -v+21d +%s)
curl -X POST -H "Content-type: application/json" \
-d '{
"scope": "env:prod",
"start": '"${start}"',
"end": '"${end}"',
"recurrence": {
"type": "weeks",
"period": 1,
"week_days": ["Mon", "Tue", "Wed", "Thu", "Fri"],
"until_date": '"${end_recurrence}"'
}
}' \
"https://api.datadoghq.com/api/v1/downtime?api_key=${api_key}&application_key=${app_key}"
{
'active': True,
'canceled': None,
'creator_id': 3658,
'disabled': False,
'end': 1445978817,
'id': 169267576,
'message': None,
'monitor_id': None,
'monitor_tags': ['*'],
'parent_id': None,
'recurrence': {
'period': 1,
'type': 'weeks',
'until_date': 1448387217,
'until_occurrences': None,
'week_days': [
'Mon',
'Tue',
'Wed',
'Thu',
'Fri'
]
},
'scope': ['env:staging'],
'start': 1445968017,
'updater_id': None
}
[
"200", {
"disabled" => false,
"canceled" => nil,
"active" => true,
"message" => nil,
"id" => 169267581,
"end" => 1445978819,
"parent_id" => nil,
"monitor_id" => nil,
"monitor_tags": ["*"],
"recurrence" => {
"until_date" => 1448387219,
"until_occurrences" => nil,
"week_days" => ["Mon", "Tue", "Wed", "Thu", "Fri"],
"type" => "weeks",
"period" => 1
},
"start" => 1445968019,
"creator_id" => 3658,
"scope" => ["env:testing"],
"updater_id" => nil
}
]
{
"active": true,
"canceled": null,
"creator_id": 3658,
"disabled": false,
"end": 1445979093,
"id": 169267786,
"message": null,
"monitor_id": null,
"monitor_tags": ["*"],
"parent_id": null,
"recurrence": {
"period": 1,
"type": "weeks",
"until_date": 1447786293,
"until_occurrences": null,
"week_days": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri"
]
},
"scope": [
"env:prod"
],
"start": 1445968293,
"updater_id": null
}
id [必須]:
更新するダウンタイムの整数 IDscope [必須]:
ダウンタイムが適用されるスコープ (例: ‘host:app2’)。複数のスコープは、カンマ区切りリストで指定します (例: ‘env:dev,env:prod’)。設定されるダウンタイムは、指定されたスコープのいずれかではなく、すべて (env:dev と env:prod の両方) と一致するソースに適用されます。monitor_tags [オプション、デフォルト = モニタータグフィルターなし]:
モニタータグのカンマ区切りリスト。これは、(scope パラメーターで絞り込まれる) モニタークエリで使用されるタグではなく、ダウンタイムが適用されるモニターに直接適用されるタグです。設定されるダウンタイムは、指定されたモニタータグのいずれかではなく、すべて (service:postgres と team:frontend の両方) と一致するモニターに適用されます。monitor_id [オプション、デフォルト = None]:
ダウンタイムが適用される単一のモニター。指定しない場合、ダウンタイムはすべてのモニターに適用されます。start [オプション、default = 元の start]:
ダウンタイムを開始する時間の POSIX タイムスタンプ。end [オプション、default = 元の end]:
ダウンタイムを終了する時間の POSIX タイムスタンプ。指定しない場合、ダウンタイムは (取り消されるまで) 無期限に有効になります。message [必須、デフォルト = 元の message]:
このダウンタイムの通知に含めるメッセージ。イベントと同じ「@username」表記を使用して、特定のユーザーに電子メール通知を送信できます。timezone [オプション、デフォルト = 元の timezone ]:
ダウンタイムのタイムゾーン。recurrence [オプション、default = 元の recurrence]:
さまざまなパラメーターを使用してダウンタイムの繰り返しを定義するオブジェクト。type: 繰り返しのタイプ。days、weeks、months、years から選択します。period: 繰り返す頻度を整数で指定します。たとえば、3 日ごとに繰り返す場合、type は days、period は 3 を指定します。week_days: (オプション) 繰り返す曜日のリスト。Mon、Tue、Wed、Thu、Fri、Sat、Sun から選択します。type が weeks の場合にのみ適用されます。最初の文字は大文字にする必要があります。until_occurrences: (オプション) ダウンタイムを再スケジューリングする回数。until_occurences と until_date は相互に排他的です。until_date: (オプション) 繰り返しが終了する日付を指定する POSIX タイムスタンプ。until_occurences と until_date は相互に排他的です。PUT /v1/downtime/<DOWNTIME_ID>
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Get an existing downtime
stagingDowntimes = []
downtimes = api.Downtime.get_all()
for item in downtimes:
if item['scope'] == ['env:staging']:
stagingDowntimes.append(item)
# Update that downtime
api.Downtime.update(
stagingDowntimes[0]['id'],
scope='env:staging',
end=int(time.time()) + 60000,
message="Doing some testing on staging."
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Update downtime
stagingDowntimes = []
downtimes = dog.get_all_downtimes()
downtimes[1].each do |item |
print item['scope']
if item['scope'] == ['env:staging']
stagingDowntimes.push item
end
end
dog.update_downtime(stagingDowntimes[0]['id'], :scope => 'env:testing', :end => Time.now.to_i + 60000, :message => "Doing some testing on staging.")api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
downtime_id=4336
# Create a downtime to update
currenttime=$(date +%s)
downtime_id=$(curl -X POST -H "Content-type: application/json" \
-d "{
\"scope\": \"env:prod\",
\"start\": \"${currenttime}\"
}" \
"https://api.datadoghq.com/api/v1/downtime?api_key=${api_key}&application_key=${app_key}" | jq '.id')
curl -X PUT -H "Content-type: application/json" \
-d '{
"scope": "env:staging",
"message": "Doing some testing on staging"
}' \
"https://api.datadoghq.com/api/v1/downtime/${downtime_id}?api_key=${api_key}&application_key=${app_key}"
{
'active': True,
'disabled': False,
'end': 1420447087,
'id': 2910,
'message': 'Doing some testing on staging.',
'monitor_tags': ['*'],
'scope': ['env:staging'],
'start': 1420387032
}
[
"200", {
"end" => 1418303372,
"disabled" => false,
"start" => 1418224729,
"active" => true,
"monitor_tags": ["*"],
"scope" => ["env:testing"],
"message" => "Doing some testing on staging.",
"id" => 4336
}
]
{
"active": true,
"disabled": false,
"end": 1418303372,
"id": 4336,
"message": "Doing some testing on staging",
"monitor_tags": ["*"],
"scope": [
"env:staging"
],
"start": 1418224729
}
id [必須]:DELETE /v1/downtime/<DOWNTIME_ID>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Cancel downtime
api.Downtime.delete(1654)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Cancel downtime
dog.cancel_downtime(1655)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
downtime_id=1656
# Create a downtime to delete
currenttime=$(date +%s)
downtime_id=$(curl -X POST -H "Content-type: application/json" \
-d "{
\"scope\": \"env:prod\",
\"start\": \"${currenttime}\"
}" \
"https://api.datadoghq.com/api/v1/downtime?api_key=${api_key}&application_key=${app_key}" | jq '.id')
curl -X DELETE -H "Content-type: application/json" "https://api.datadoghq.com/api/v1/downtime/${downtime_id}?api_key=${api_key}&application_key=${app_key}"This endpoint does not return JSON on successful requests.
このエンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
scope [必須]:
指定されたスコープを持つすべてのダウンタイムを取り消します。次に例を示します。
POST /v1/downtime/cancel/by_scope
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/bash
api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
curl -X POST -H "Content-type: application/json" -H "Accept: application/json" \
-d "{
\"scope\": \"host:i-123\"
}" \
"https://api.datadoghq.com/api/v1/downtime/cancel/by_scope?api_key=${api_key}&application_key=${app_key}"#
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
#
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example {
"cancelled_ids":[123456789,123456790]
}このエンドポイントは、JSON 引数を受け取りません。
GET /v1/downtime/<DOWNTIME_ID>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Get a downtime
api.Downtime.get(2910)
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
downtime_id=2473
curl "https://api.datadoghq.com/api/v1/downtime/${downtime_id}?api_key=${api_key}&application_key=${app_key}"{'active': True,
'disabled': False,
'end': 1420447087,
'id': 2910,
'message': 'Doing some testing on staging.',
'monitor_tags': ['*'],
'scope': ['env:staging'],
'start': 1420387032
}
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"active": True,
"disabled": False,
"end": 1420447087,
"id": 2910,
"message": "Doing some testing on staging.",
"monitor_tags": ["*"],
"scope": ["env:staging"],
"start": 1420387032
}
current_only [オプション、デフォルト = False]:GET /v1/downtime
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Get all downtimes
print api.Downtime.get_all()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get all downtimes
print(dog.get_all_downtimes())api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -G "https://api.datadoghq.com/api/v1/downtime" \
-d "api_key=${api_key}" \
-d "application_key=${app_key}"
[
{
'active': False,
'disabled': True,
'end': 1412793983,
'id': 1625,
'monitor_tags': ['*'],
'scope': ['env:staging'],
'start': 1412792983
},
{
'active': False,
'disabled': True,
'end': None,
'id': 1626,
'monitor_tags': ['*'],
'scope': ['*'],
'start': 1412792985
}
]
[
"200", [{
"end" => 1412793983,
"disabled" => true,
"start" => 1412792983,
"active" => false,
"monitor_tags" => ["*"],
"scope" => ["env:staging"],
"id" => 1625
}, {
"end" => nil,
"disabled" => true,
"start" => 1412792985,
"active" => false,
"monitor_tags" => ["*"],
"scope" => ["*"],
"id" => 1626
}]
]
[
{
"active": false,
"disabled": true,
"end": 1412793983,
"id": 1625,
"monitor_tags": ["*"],
"scope": [
"env:staging"
],
"start": 1412792983
},
{
"active": false,
"disabled": true,
"end": null,
"id": 1626,
"monitor_tags": ["*"],
"scope": [
"*"
],
"start": 1412792985
}
]
API を使用して埋め込み可能なグラフを操作します。
これまでに作成された埋め込み可能なグラフのリストを取得します。
戻り値: これまでに UI および API から作成された Embed に関する情報を含む JSON リスト。各 JSON グラフ応答は、GET api/v1/graph/embed/
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/graph/embed
from datadog import initialize, api
# Intialize request parameters including API/APP key
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Call Embed API function
api.Embed.get_all()
require 'rubygems'
require 'dogapi'
# Initialize API Client
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get all with API Call
dog.get_all_embeds()api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
curl -X GET "https://api.datadoghq.com/api/v1/graph/embed?api_key=${api_key}&application_key=${app_key}"
{
"embedded_graphs": [
{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title": "Embed created through API",
"revoked": False,
"dash_url": None,
"shared_by": 3658,
"dash_name": None
}
]
}
{
"embedded_graphs" => [{
"embed_id" => "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables" => [],
"html" => '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title" => "Embed created through API",
"revoked" => false,
"dash_url" => nil,
"shared_by" => 3658,
"dash_name" => nil
}]
}{ "embedded_graphs": [
{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": "<iframe src=\"https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true\" width=\"600\" height=\"300\" frameBorder=\"0\"></iframe>",
"graph_title": "Embed created through API",
"revoked": false,
"dash_url": null,
"shared_by": 3658,
"dash_name": null
}
]
}
埋め込み可能なグラフを新しく作成します。
戻り値: GET api/v1/graph/embed/
注: 指定されたオーガニゼーションにまったく同じクエリに対応する Embed が既に存在する場合、新しい Embed は作成されず、古い Embed が返されます。
テンプレート変数の使用に関心がある方は、テンプレート変数を使用した埋め込み可能なグラフを参照してください。
graph_json [必須]:timeframe [オプション、デフォルト = 1_hour]:size [オプション、デフォルト = medium]:legend [オプション、デフォルト = no]:title [オプション、デフォルト = Embed created through API]:POST /v1/graph/embed
from datadog import initialize, api
import json
# Intialize request parameters including API/APP key
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Create an embed graph definition as a dict and format as JSON
graph_json = {
"requests": [{
"q": "avg:system.load.1{*}"
}],
"viz": "timeseries",
"events": []
}
graph_json = json.dumps(graph_json)
api.Embed.create(
graph_json=graph_json,
timeframe="1_hour",
size="medium",
legend="no"
)
require 'rubygems'
require 'dogapi'
# Initialize API Client
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Prepare parameters
graph_json = '{
"requests": [{
"q": "avg:system.load.1{*}"
}],
"viz": "timeseries",
"events": []
}
'
timeframe = "1_hour"
size = "medium"
legend = "no"
title = "Embed created through API"
# Create parameter hash
description = {:timeframe => timeframe, :size => size, :legend => legend, :title => title
}
# Make API Call
status, result = dog.create_embed(graph_json, description)api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
curl -POST \
-d 'graph_json={"requests":[{"q":"avg:system.load.1{*}"}],"viz":"timeseries","events":[]}' \
-d "timeframe=1_hour" \
-d "size=medium" \
-d "legend=yes" \
"https://api.datadoghq.com/api/v1/graph/embed?api_key=${api_key}&application_key=${app_key}"
{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title": "Embed created through API",
"revoked": False,
"dash_url": None,
"shared_by": 3658,
"dash_name": None
}
{
"embed_id" => "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables" => [],
"html" => '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title" => "Embed created through API",
"revoked" => false,
"dash_url" => nil,
"shared_by" => 3658,
"dash_name" => nil
}{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": "<iframe src=\"https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true\" width=\"600\" height=\"300\" frameBorder=\"0\"></iframe>",
"graph_title": "Embed created through API",
"revoked": false,
"dash_url": null,
"shared_by": 3658,
"dash_name": null
}
embed_id を指定して、以前に作成した Embed の HTML フラグメントを取得します。
戻り値: 以下の 8 つの要素を持つ JSON オブジェクト。
失敗すると、戻り値はエラーメッセージ {errors: [messages]} を含む JSON になります。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/graph/embed/<EMBED_ID>
from datadog import initialize, api
# Intialize request parameters including API/APP key
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Set Embed ID (token)
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Call Embed API function
api.Embed.get(embed_id, legend="no", size="medium", timeframe="1_hour")
require 'rubygems'
require 'dogapi'
# Initialize API Client
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Initialize Embed Token / ID
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Get embed with API Call
dog.enable_embed(embed_id)api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
embed_id="5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
curl -X GET "https://api.datadoghq.com/api/v1/graph/embed/${embed_id}?api_key=${api_key}&application_key=${app_key}"
{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title": "Embed created through API",
"revoked": False,
"dash_url": None,
"shared_by": 3658,
"dash_name": None
}
{
"embed_id" => "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables" => [],
"html" => '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title" => "Embed created through API",
"revoked" => false,
"dash_url" => nil,
"shared_by" => 3658,
"dash_name" => nil
}{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": "<iframe src=\"https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true\" width=\"600\" height=\"300\" frameBorder=\"0\"></iframe>",
"graph_title": "Embed created through API",
"revoked": false,
"dash_url": null,
"shared_by": 3658,
"dash_name": null
}
特定の Embed を有効にします。
戻り値: 成功メッセージ {success: [message]} を含む JSON。失敗すると、戻り値はエラーメッセージ {errors: [messages]} を含む JSON になります。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/graph/embed/<EMBED_ID>/enable
from datadog import initialize, api
# Intialize request parameters including API/APP key
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Set Embed ID (token)
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Call Embed API function
api.Embed.enable(embed_id)
require 'rubygems'
require 'dogapi'
# Initialize API Client
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Initialize Embed Token / ID
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Enable with API Call
dog.enable_embed(embed_id)api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
embed_id="5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
curl -X GET "https://api.datadoghq.com/api/v1/graph/embed/${embed_id}/enable?api_key=${api_key}&application_key=${app_key}"
{
"success": "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully enabled."
}
{
"success" => "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully enabled."
}{
"success": "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully enabled."
}
特定の Embed を無効にします。
戻り値: 成功メッセージ {success: [message]} を含む JSON。失敗すると、戻り値は、エラーメッセージ {errors: [messages]} を含む JSON になります。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/graph/embed/<EMBED_ID>/revoke
from datadog import initialize, api
# Intialize request parameters including API/APP key
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Set Embed ID (token)
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Call Embed API function
api.Embed.revoke(embed_id)
require 'rubygems'
require 'dogapi'
# Initialize API Client
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Initialize Embed Token / ID
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Revoke with API Call
dog.revoke_embed(embed_id)api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
embed_id="5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
curl -X GET "https://api.datadoghq.com/api/v1/graph/embed/${embed_id}/revoke?api_key=${api_key}&application_key=${app_key}"
{
"success": "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully revoked."
}
{
"success" => "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully revoked."
}{
"success": "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully revoked."
}
このエンドポイントを使用して、イベントをストリームにポストできます。イベントにタグ付けし、優先度を設定し、他のイベントと統合します。
title [必須]:
イベントのタイトル。上限は 100 文字です。
Datadog Ruby ライブラリでは、msg_title を使用してください。text [必須]:
イベントの本文。上限は 4000 文字です。
テキストはマークダウンをサポートしています。
Datadog Ruby ライブラリでは、msg_text を使用してください。date_happened [オプション、default = 現在]:
イベントの POSIX タイムスタンプ 整数として (引用符なしで) 送信する必要があります。1 年と 24 日 (389 日) 以内のイベントに制限されます。priority [オプション、デフォルト = normal]:
イベントの優先度。normal か low のいずれか。host [オプション、デフォルト = None]:
イベントに関連付けるホスト名。ホストに関連付けられているタグがあれば、それらもこのイベントに適用されます。tags [オプション、デフォルト = None]:
イベントに適用するタグのリスト。alert_type [オプション、デフォルト = info]:
アラートイベントの場合は、error、warning、info、success のいずれかのタイプを設定します。aggregation_key [オプション、デフォルト = None]:
集約に使用する任意の文字列。上限は 100 文字です。
キーを指定した場合は、そのキーを使用するすべてのイベントがイベントストリーム内でグループ化されます。source_type_name [オプション、デフォルト = None]:
ポストされるイベントのタイプ。
オプションには、nagios、hudson、jenkins、my_apps、chef、puppet、git、bitbucket などがあります。
ソース属性値のリストはこちらを参照してください。related_event_id [オプション、デフォルト = None]:
親イベントの ID。整数として (引用符なしで) 送信する必要があります。device_name [オプション、デフォルト = None]:
イベントのポストに使用するデバイス名のリスト。POST /v1/events
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
title = "Something big happened!"
text = 'And let me tell you all about it here!'
tags = ['version:1', 'application:web']
api.Event.create(title=title, text=text, tags=tags)
# If you are programmatically adding a comment to this new event
# you might want to insert a pause of .5 - 1 second to allow the
# event to be available.
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# submitting events doesn 't require an application_key,
# so we don't bother setting it
dog = Dogapi::Client.new(api_key)
dog.emit_event(Dogapi::Event.new('msg_text', :msg_title => 'Title'))
# If you are programmatically adding a comment to this new event
# you might want to insert a pause of.5 - 1 second to allow the
# event to be available.
curl -X POST -H "Content-type: application/json" \
-d '{
"title": "Did you hear the news today?",
"text": "Oh boy!",
"priority": "normal",
"tags": ["environment:test"],
"alert_type": "info"
}' \
"https://api.datadoghq.com/api/v1/events?api_key=<YOUR_API_KEY>"
{
'event':
{
'date_happened': 1419436860,
'handle': None,
'id': 2603387619536318140,
'priority': 'normal',
'related_event_id': None,
'tags': ['version:1', 'application:web'],
'text': 'And let me tell you all about it here!',
'title': 'Something big happened!',
'url': 'https://app.datadoghq.com/event/jump_to?event_id=2603387619536318140'
},
'status': 'ok'
}
[
"202", {
"status" => "ok",
"event" => {
"priority" => "normal",
"date_happened" => 1346452418,
"title" => "Title",
"url" =>
"https://app.datadoghq.com/event/jump_to?event_id=1378911893708573827",
"text" => "msg_text",
"tags" => [],
"related_event_id" => nil,
"id" => 1378911893708573827
}
}
]{
"event": {
"date_happened": 1346449298,
"handle": null,
"id": 1378859526682864843,
"priority": "normal",
"related_event_id": null,
"tags": [
"environment:test"
],
"text": null,
"title": "Did you hear the news today?",
"url": "https://app.datadoghq.com/event/jump_to?event_id=1378859526682864843"
},
"status": "ok"
}このエンドポイントを使用して、イベントの詳細をクエリできます。 注: クエリ対象のイベントに何らかのマークダウン形式が含まれている場合は、出力に %、\、n などの文字が表示される場合があります。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/events/<EVENT_ID>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.Event.get(2603387619536318140)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
event_id = '1375909614428331251'
dog.get_event(event_id)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
event_id=1377281704830403917
# Create an event to get
event_id=$(curl -X POST -H "Content-type: application/json" -d "{\"title\": \"Did you hear the news today?\"}" "https://api.datadoghq.com/api/v1/events?api_key=<YOUR_API_KEY>" | jq -r '.event.url|ltrimstr("https://app.datadoghq.com/event/event?id=")')
sleep 5
curl "https://api.datadoghq.com/api/v1/events/${event_id}?api_key=${api_key}&application_key=${app_key}"
{
'event': {
'alert_type': 'info',
'date_happened': 1419436860,
'device_name': None,
'host': None,
'id': 2603387619536318140,
'payload': '{}',
'priority': 'normal',
'resource': '/api/v1/events/2603387619536318140',
'tags': ['application:web', 'version:1'],
'text': 'And let me tell you all about it here!',
'title': 'Something big happened!',
'url': '/event/jump_to?event_id=2603387619536318140'
}
}
[
"200", {
"event" => {
"date_happened" => 1346273469,
"alert_type" => "info",
"resource" => "/api/v1/events/1375909614428331251",
"title" => "Something big happened!",
"url" => "/event/jump_to?event_id=1375909614428331251",
"text" => "And let me tell you all about it here!",
"tags" => ["application:web", "version:1"],
"id" => 1375909614428331251,
"priority" => "normal",
"host" => nil,
"device_name" => nil,
"payload" => "{}"
}
}
]{
"event": {
"alert_type": "info",
"date_happened": 1346355252,
"device_name": null,
"host": null,
"id": 1377281704830403917,
"payload": "{}",
"priority": "normal",
"resource": "/api/v1/events/1377281704830403917",
"tags": [
"environment:test"
],
"text": "Oh boy!",
"title": "Did you hear the news today?",
"url": "/event/jump_to?event_id=1377281704830403917"
}
}イベントストリームをクエリして、時間、優先度、ソース、タグなどで絞り込むことができます。 注: クエリ対象のイベントに何らかのマークダウン形式が含まれている場合は、出力に %、\、n などの文字が表示される場合があります。
start [必須]:
POSIX タイムスタンプ。end [必須]:
POSIX タイムスタンプ。priority [オプション、デフォルト = None]:
イベントの優先度。low か normal のいずれか。sources [オプション、デフォルト = None]:
ソースのカンマ区切り文字列。tags [オプション、デフォルト = None]:
タグのカンマ区切り文字列。負のタグフィルターを使用する場合は、タグの先頭に - を付けます。
詳細は、イベントストリームのドキュメントを参照してください。unaggregated [オプション、デフォルト = false]:
unaggregated を true に設定すると、指定された [start,end] タイムフレーム内のすべてのイベントが返されます。そうでない場合、タイムフレーム外のタイムスタンプを持つ親イベントに集約されたイベントは、出力に含まれません。GET /v1/events
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
end_time = time.time()
start_time = end_time - 100
api.Event.query(
start=start_time,
end=end_time,
priority="normal",
tags=["-env:dev,application:web"],
unaggregated=True
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
end_time = Time.now.to_i
start_time = end_time - 100
dog.stream(start_time, end_time, :priority => "normal", :tags => ["-env:dev,application:web"], :unaggregated => true)# Note: this endpoint only accepts form-encoded requests.
currenttime=$(date +%s)
currenttime2=$(date --date='1 day ago' +%s)
curl -G -H "Content-type: application/json" \
-d "start=${currenttime2}" \
-d "end=${currenttime}" \
-d "sources=My Apps" \
-d "tags=-env:dev,application:web" \
-d "unaggregated=true"\
-d "api_key=<YOUR_API_KEY>" \
-d "application_key=<YOUR_APP_KEY>" \
"https://api.datadoghq.com/api/v1/events"
{
'events': [
{
'alert_type': 'info',
'comments': [],
'date_happened': 1346273496,
'device_name': null,
'host': null,
'id': 1375910067732769979,
'is_aggregate': false,
'priority': 'normal',
'resource': '/api/v1/events/1375910067732769979',
'source': 'My Apps',
'tags': [
'application:web',
'version:1'
],
'text': 'And let me tell you all about it here!',
'title': 'Something big happened!',
'url': '/event/jump_to?event_id=1375910067732769979'
},
{
'alert_type': 'info',
'comments': [],
'date_happened': 1346273469,
'device_name': null,
'host': null,
'id': 1375909614428331251,
'is_aggregate': false,
'priority': 'normal',
'resource': '/api/v1/events/1375909614428331251',
'source': 'My Apps',
'tags': [
'application:web',
'version:1'
],
'text': 'And let me tell you all about it here!',
'title': 'Something big happened!',
'url': '/event/jump_to?event_id=1375909614428331251'
}
]
}
["200", {
"events" => [{
"events" => [{
"alert_type" => "info",
"comments" => [],
"date_happened" => 1346273496,
"device_name" => null,
"host" => null,
"id" => 1375910067732769979,
"is_aggregate" => false,
"priority" => "normal",
"resource" => "/api/v1/events/1375910067732769979",
"source" => "My Apps",
"tags" => [
"application:web",
"version:1"
],
"text" => "And let me tell you all about it here!",
"title" => "Something big happened!",
"url" => "/event/jump_to?event_id=1375910067732769979"
}, {
"alert_type" => "info",
"comments" => [],
"date_happened" => 1346273469,
"device_name" => null,
"host" => null,
"id" => 1375909614428331251,
"is_aggregate" => false,
"priority" => "normal",
"resource" => "/api/v1/events/1375909614428331251",
"source" => "My Apps",
"tags" => [
"application:web",
"version:1"
],
"text" => "And let me tell you all about it here!",
"title" => "Something big happened!",
"url" => "/event/jump_to?event_id=1375909614428331251"
}]
}]
}]{
"events": [
{
"alert_type": "info",
"comments": [],
"date_happened": 1346273496,
"device_name": null,
"host": null,
"id": 1375910067732769979,
"is_aggregate": false,
"priority": "normal",
"resource": "/api/v1/events/1375910067732769979",
"source": "My Apps",
"tags": [
"application:web",
"version:1"
],
"text": "And let me tell you all about it here!",
"title": "Something big happened!",
"url": "/event/jump_to?event_id=1375910067732769979"
},
{
"alert_type": "info",
"comments": [],
"date_happened": 1346273469,
"device_name": null,
"host": null,
"id": 1375909614428331251,
"is_aggregate": false,
"priority": "normal",
"resource": "/api/v1/events/1375909614428331251",
"source": "My Apps",
"tags": [
"application:web",
"version:1"
],
"text": "And let me tell you all about it here!",
"title": "Something big happened!",
"url": "/event/jump_to?event_id=1375909614428331251"
}
]
}APIを使って graph のスナップショットを撮る
注: スナップショットは、作成されてから利用できるようになるまで、若干の遅延があります。
metric_query [必須]:
メトリクスクエリ。start [必須]:
クエリを開始する時間の POSIX タイムスタンプ。end [必須]:
クエリを終了する時間の POSIX タイムスタンプ。event_query [オプション、デフォルト = None]:
グラフにイベントバンドを追加するためのクエリ。graph_def [オプション、デフォルト = None]:
グラフを定義する JSON ドキュメント。metric_query の代わりに graph_def を使用できます。この JSON ドキュメントは、こちらで定義されている文法を使用し、単一行の書式にしてから URL エンコードする必要があります。title [オプション、デフォルト = None]:
グラフのタイトル。タイトルを指定しない場合、グラフにタイトルは付きません。GET /v1/graph/snapshot
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Take a graph snapshot
end = int(time.time())
start = end - (60 * 60)
api.Graph.create(
graph_def='{\
"viz": "timeseries", \
"requests": [ \
{"q": "avg:system.load.1{*}", "conditional_formats": [], "type": "line"},\
{"q": "avg:system.load.5{*}", "type": "line"}, \
{"q": "avg:system.load.15{*}", "type": "line"}\
], \
"events": [\
{"q": "hosts:* ", "tags_execution": "and"}\
]}',
start=start,
end=end
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
end_ts = Time.now().to_i
start_ts = end_ts - (60 * 60)
dog.graph_snapshot("system.load.1{*}", start_ts, end_ts)
currenttime=$(date +%s)
currenttime2=$(date -v -1d +%s)
curl -G -H "Content-type: application/json" \
-d "metric_query=system.load.1{*}" \
-d "start=${currenttime2}" \
-d "end=${currenttime}" \
-d "api_key=<YOUR_API_KEY>" \
-d "application_key=<YOUR_APP_KEY>" \
"https://api.datadoghq.com/api/v1/graph/snapshot"
{
'graph_def': {"viz": "timeseries", "requests": [{"q": "avg:system.load.1{*}", "conditional_formats": [], "type": "line"}, {"q": "avg:system.load.5{*}", "type": "line"}, {"q": "avg:system.load.15{*}", "type": "line"}], "events": [{"q": "hosts:* ", "tags_execution": "and"}]}',
'metric_query': 'system.load.1{*}',
'snapshot_url': 'https://s3.amazonaws.com/dd-snapshots-prod/org_1499/2013-07-19/2459d291fc021c84f66aac3a87251b6c92b589da.png'
}
["200", {
"metric_query" => "system.load.1{*}",
"snapshot_url" =>
"https://s3.amazonaws.com/dd-snapshots-prod/org_1499/2013-07-19/7f6dd29198ce0872a6fdfab33f534ef8d64a23ea.png"
}]{
"metric_query": "system.load.1{*}",
"snapshot_url": "https://s3.amazonaws.com/dd-snapshots-prod/org_1499/2013-07-19/53fd79f024e7796f4ca399f1d90adf3cf95a9bb8.png"
}
This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included. Results are paginated with a max of 100 results at a time.
filter [optional, default=None]:
Query string to filter search results.sort_field [optional, default=cpu]:
Sort hosts by the given field.
Options: status, apps, cpu, iowait, loadsort_dir [optional, default=desc]:
Direction of sort.
Options: asc, descstart [optional, default=0]:
Host result to start search from.count [optional, default=100]:
Number of host results to return. Max 100.from [optional, default=now - 2 hours]:
Number of seconds since UNIX epoch from which you want to search your hosts.GET /v1/hosts
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.Hosts.search()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.search_hosts()
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -G "https://api.datadoghq.com/api/v1/hosts" \
-d "api_key=${api_key}" \
-d "application_key=${app_key}"
{
'total_returned': 1,
"last_reported_time": 1560000000,
'host_list': [
{
'name': 'i-deadbeef',
'up': True,
'is_muted': False,
'apps': [
'agent'
],
'tags_by_source': {
'Datadog': [
'host:i-deadbeef'
],
'Amazon Web Services': [
'account:staging'
]
},
'aws_name': 'mycoolhost-1',
'metrics': {
'load': 0.5,
'iowait': 3.2,
'cpu': 99.0
},
'sources': [
'aws',
'agent'
],
'meta': {
'nixV': [
'Ubuntu',
'14.04',
'trusty'
]
},
'host_name': 'i-deadbeef',
'id': 123456,
'aliases': [
'mycoolhost-1'
]
}
],
'total_matching': 1
}
["200", {
"total_returned": 1,
"last_reported_time": 1560000000,
"host_list": [
{
"name": "i-deadbeef",
"up": true,
"is_muted": false,
"apps": [
"agent"
],
"tags_by_source": {
"Datadog": [
"host:i-deadbeef"
],
"Amazon Web Services": [
"account:staging"
]
},
"aws_name": "mycoolhost-1",
"metrics": {
"load": 0.5,
"iowait": 3.2,
"cpu": 99.0
},
"sources": [
"aws",
"agent"
],
"meta": {
"nixV": [
"Ubuntu",
"14.04",
"trusty"
]
},
"host_name": "i-deadbeef",
"id": 123456,
"aliases": [
"mycoolhost-1"
]
}
],
"total_matching": 1
}]
{
"total_returned": 1,
"last_reported_time": 1560000000,
"host_list": [
{
"name": "i-deadbeef",
"up": true,
"is_muted": false,
"apps": [
"agent"
],
"tags_by_source": {
"Datadog": [
"host:i-deadbeef"
],
"Amazon Web Services": [
"account:staging"
]
},
"aws_name": "mycoolhost-1",
"metrics": {
"load": 0.5,
"iowait": 3.2,
"cpu": 99.0
},
"sources": [
"aws",
"agent"
],
"meta": {
"nixV": [
"Ubuntu",
"14.04",
"trusty"
]
},
"host_name": "i-deadbeef",
"id": 123456,
"aliases": [
"mycoolhost-1"
]
}
],
"total_matching": 1
}
This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours.
from [optional, default=now - 2 hours]:
Number of seconds since UNIX epoch from which you want to get the total number of active and up hosts.GET /v1/hosts/totals
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.Hosts.totals()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.host_totals()
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -G "https://api.datadoghq.com/api/v1/hosts/totals" \
-d "api_key=${api_key}" \
-d "application_key=${app_key}"
{'total_up':1750,'total_active':1759, "last_reported_time": 1560000000}
["200", {"total_up":1750,"total_active":1759, "last_reported_time": 1560000000}]
{"total_up":1750,"total_active":1759, "last_reported_time": 1560000000}
end [オプション、デフォルト = None]:
ホストがミュート解除される時間の POSIX タイムスタンプ。省略した場合、ホストは、明示的にミュート解除されるまでミュートされたままになります。message [オプション、デフォルト = None]:
このホストのミュートに関連付けるメッセージ。override [オプション、デフォルト = False]:
true にした場合、ホストが既にミュートされていると、既存のホストミュート設定が置き換えられます。POST /v1/host/<HOSTNAME>/mute
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Find a host to mute
hosts = api.Hosts.search(q='hosts:')
# Mute a host
api.Host.mute(hosts['results']['hosts'][0])
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
hostname = "test.host"
message = "Muting this host for a test."
end_ts = Time.now.to_i + 60 * 60
dog.mute_host(hostname, :message => message, :end => end_ts)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"message": "Muting this host for a test!"
}' "https://api.datadoghq.com/api/v1/host/test.host/mute?api_key=${api_key}&application_key=${app_key}"
{
'action': 'Muted',
'hostname': 'test.host'
}
["200", {
"action"=>"Muted",
"message"=>"Muting this host for a test.",
"hostname"=>"test.host",
"end"=>1433345249
}]{
"action": "Muted",
"hostname": "test.host",
"message": "Muting this host for a test!"
}
このエンドポイントは、JSON 引数を受け取りません。
POST /v1/host/<HOSTNAME>/unmute
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Find a host to unmute
hosts = api.Hosts.search(q='hosts:')
# Unmute host
api.Host.unmute(hosts['results']['hosts'][0])
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
hostname = "test.host"
dog.unmute_host(hostname)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" "https://api.datadoghq.com/api/v1/host/test.host/unmute?api_key=${api_key}&application_key=${app_key}"
{
'action': 'Unmuted',
'hostname': 'test.host'
}
["200", {
"action" => "Unmuted",
"hostname" => "test.host"
}]{
"action": "Unmuted",
"hostname": "test.host"
}AWS エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-AWS インテグレーションの構成は、Datadog API から直接行います。 詳細については、[AWS インテグレーションのページ][7]を参照してください。
Datadog Organization で使用できるすべての Datadog-AWS インテグレーションをリストします。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/integration/aws
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# List AWS Accounts (role-based only) in Datadog
curl -X GET "https://api.datadoghq.com/api/v1/integration/aws?api_key=${api_key}&application_key=${app_key}"# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{"accounts":
[{
"account_id": '112233445566',
"role_name": "SomeDatadogRole",
"filter_tags": ["filter123"],
"host_tags": ["account":"demo"],
"account_specific_namespace_rules": {"opsworks":false}
}]
}
Datadog-Amazon Web Services インテグレーションを作成します。
注: POST メソッドを使用すると、Datadog Organization の既存の構成に新しい構成を追加して、インテグレーション構成が更新されます。
account_id [必須]:
AWS アカウント ID (ダッシュを含まない)。 AWS アカウント ID の詳細については、Datadog AWS インテグレーションを参照してください。
access_key_id [オプション、デフォルト = None]:
AWS アカウントが GovCloud または China アカウントの場合に、対応するアクセスキー ID を入力します。
role_name [必須]:
Datadog ロールの委任名。 AWS アカウントのロール名の詳細については、Datadog AWS インテグレーション構成情報を参照してください。
filter_tags [オプション、デフォルト = None]:
この EC2 タグ (key:value 形式) の配列は、EC2 からメトリクスを収集する際に Datadog が使用するフィルターを定義します。? (1 文字) や * (複数文字) などのワイルドカードも使用できます。
定義されたタグのいずれかに一致するホストだけが Datadog にインポートされます。それ以外は無視されます。タグの前に ! を追加することで、指定されたタグに一致するホストを除外することもできます。
例: env:production,instance-type:c1.*,!region:us-east-1
EC2 のタグ付けの詳細については、AWS のタグ付けに関するドキュメントを参照してください。
host_tags [オプション、デフォルト = None]:
このインテグレーションを介して報告しているすべてのホストおよびメトリクスに追加されるタグ (key:value 形式) の配列。
account_specific_namespace_rules [オプション、デフォルト = None]:
この AWS アカウントでのみ特定の AWS ネームスペースに対してメトリクスの収集を有効または無効にするためのオブジェクト ({"namespace1":true/false, "namespace2":true/false} 形式)。ネームスペースのリストは、/v1/integration/aws/available_namespace_rules エンドポイントから取得できます。
POST /v1/integration/aws
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# Create an AWS Account in Datadog
curl -X POST -H "Content-type: application/json" \
-d '{
"account_id": "<AWS_ACCOUNT_ID>",
"filter_tags": ["<KEY>:<VALUE>"],
"host_tags": ["<KEY>:<VALUE>"],
"role_name": "DatadogAWSIntegrationRole",
"account_specific_namespace_rules": {
"auto_scaling": false,
"opsworks": false
}
}'\
"https://api.datadoghq.com/api/v1/integration/aws?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example{
"external_id": "12345678910111213"
}Update a Datadog-Amazon Web Services integration.
Note: Using the PUT method updates your integration configuration by replacing your current configuration with the new one sent to your Datadog organization.
account_id [required]:
Your AWS Account ID without dashes. It needs to be passed as query parameter. Consult the Datadog AWS integration to learn more about your AWS account ID.
role_name [required]:
Your Datadog role delegation name. It needs to be passed as query parameter. For more information about your AWS account Role name, see the Datadog AWS integration configuration info.
access_key_id [optional, default=None]:
If your AWS account is a GovCloud or China account, enter the corresponding Access Key ID.
filter_tags [optional, default=None]:
The array of EC2 tags (in the form key:value) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as ? (for single characters) and * (for multiple characters) can also be used.
Only hosts that match one of the defined tags are imported into Datadog. The rest are ignored. Host matching a given tag can also be excluded by adding ! before the tag.
e.x. env:production,instance-type:c1.*,!region:us-east-1
For more information on EC2 tagging, see the AWS tagging documentation.
host_tags [optional, default=None]:
Array of tags (in the form key:value) to add to all hosts and metrics reporting through this integration.
account_specific_namespace_rules [optional, default=None]:
An object (in the form {"namespace1":true/false, "namespace2":true/false}) that enables or disables metric collection for specific AWS namespaces for this AWS account only. A list of namespaces can be found at the /v1/integration/aws/available_namespace_rules endpoint.
PUT /v1/integration/aws
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# Update an AWS Account in Datadog
curl -X PUT \
"https://api.datadoghq.com/api/v1/integration/aws?api_key=${api_key}&application_key=${app_key}&account_id=<YOUR_AWS_ACCOUNT_ID>&role_name=<ROLE_NAME>" \
-H 'Content-Type: application/json' \
-d '{
"filter_tags": [
"<TAG_KEY>:<TAG_VALUE>"
],
"host_tags": [
"<TAG_KEY>:<TAG_VALUE>"
],
"account_specific_namespace_rules": {
"auto_scaling": false,
"opsworks": false
}
}'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example{}
特定の Datadog-AWS インテグレーションを削除します。
account_id [必須]:
AWS アカウント ID (ダッシュを含まない)。 AWS アカウント ID の詳細については、Datadog AWS インテグレーションを参照してください。
role_name [必須]:
Datadog ロールの委任名。 AWS アカウントのロール名の詳細については、Datadog AWS インテグレーション構成情報を参照してください。
DELETE /v1/integration/aws
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# Delete an AWS Account in Datadog
curl -X DELETE -H "Content-type: application/json" \
-d '{
"account_id": "<AWS_ACCOUNT_ID>",
"role_name": "DatadogAWSIntegrationRole"
}' \
"https://api.datadoghq.com/api/v1/integration/aws?api_key=${api_key}&application_key=${app_key}"# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example{}特定の Datadog-AWS インテグレーションのすべてのネームスペース規則をリストします。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/integration/aws/available_namespace_rules
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# List available namespace rules
curl -X GET "https://api.datadoghq.com/api/v1/integration/aws/available_namespace_rules?api_key=${api_key}&application_key=${app_key}"# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example["api_gateway","application_elb","appsync","auto_scaling","billing","budgeting","cloudfront","cloudsearch","cloudwatch_events","cloudwatch_logs","codebuild","collect_custom_metrics","crawl_alarms","ddos_protection","directconnect","dms","documentdb","dynamodb","ebs","ec2","ec2api","ec2spot","ecs","efs","elasticache","elasticbeanstalk","elastictranscoder","elb","emr","es","firehose","gamelift","iot","kinesis","kinesis_analytics","kms","lambda","lex","ml","mq","nat_gateway","network_elb","opsworks","polly","rds","redshift","rekognition","route53","s3","sagemaker","ses","sns","sqs","state_machine","storage_gateway","swf","vpn","waf","workspaces","xray"]特定の AWS アカウント ID/ロール名ペアに対して新しい AWS 外部 ID を作成します。
account_id [必須]:
AWS アカウント ID (ダッシュを含まない)。 AWS アカウント ID の詳細については、Datadog AWS インテグレーションを参照してください。
role_name [必須]:
Datadog ロールの委任名。 AWS アカウントのロール名の詳細については、Datadog AWS インテグレーション構成情報を参照してください。
PUT /v1/integration/aws/generate_new_external_id
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT -H "Content-type: application/json"
-d
'{
"account_id": "<YOUR_AWS_ACCOUNT_ID>",
"role_name": "DatadogAWSIntegrationRole"
}'
"https://dd.datadoghq.com/api/v1/integration/aws/generate_new_external_id?${api_key}&application_key=${app_key}"# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}Get the list of current AWS services that Datadog offers automatic log collection.
Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
This endpoint takes no JSON arguments.
GET /aws/logs/services
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET "https://api.datadoghq.com/api/v1/integration/aws/logs/services?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}Datadog-AWS ログ収集のために作成された Lambda の Lambda ARN を AWS アカウント ID に追加して、ログ収集を有効にします。
account_id [必須]:
AWS アカウント ID (ダッシュを含まない)。 AWS アカウント ID の詳細については、Datadog AWS インテグレーションを参照してください。
lambda_arn [必須]:
Datadog-Amazon Web サービスのログ収集セットアップ中に作成された Datadog Lambda の ARN。
POST /v1/integration/aws/logs
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"account_id": "<AWS_ACCOUNT_ID>",
"lambda_arn": "arn:aws:lambda:us-east-1:123456789012:function:PushLogs"
}'\
"https://api.datadoghq.com/api/v1/integration/aws/logs?api_key=${api_key}&application_key=${app_key}"# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}AWS サービスの自動ログ収集を有効にします。
account_id [必須]:
AWS アカウント ID (ダッシュを含まない)。 AWS アカウント ID の詳細については、Datadog AWS インテグレーションを参照してください。
services [必須]: 自動ログ収集を有効にするように設定されるサービス ID の配列。 使用可能なサービスのリストは、AWS ログ対応サービスのリストの取得 API エンドポイントから入手できます。
POST /v1/integration/aws/logs/services
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"account_id": "<AWS_ACCOUNT_ID>",
"services": ["elb","s3"]
}'\
"https://api.datadoghq.com/api/v1/integration/aws/logs/services?api_key=${api_key}&application_key=${app_key}"# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}Delete a Datadog-AWS log collection configuration by removing the specific Lambda ARN associated with a given AWS account.
account_id [required]:
Your AWS Account ID without dashes. Consult the Datadog AWS integration to learn more about your AWS account ID.
lambda_arn [required]:
ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup.
DELETE /v1/integration/aws/logs
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X DELETE -H "Content-type: application/json" \
-d '{
"account_id": "<AWS_ACCOUNT_ID>",
"lambda_arn": "arn:aws:lambda:us-east-1:123456789012:function:PushLogs"
}'\
"https://api.datadoghq.com/api/v1/integration/aws/logs?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}Azure エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-Azure インテグレーションの構成は、Datadog API から直接行います。 詳細については、[Datadog-Azure インテグレーションのページ][7]を参照してください。
現在のオーガニゼーションに構成されているすべての Datadog-Azure インテグレーションをリストします。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/integration/azure
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET "https://api.datadoghq.com/api/v1/integration/azure?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl exampleOKDatadog-Azure インテグレーションを作成します。
注:
POST メソッドを使用すると、Datadog Organization の既存の構成に新しい構成を追加して、インテグレーション構成が更新されます。PUT メソッドを使用すると、現在の構成を Datadog Organization に送信された新しい構成に置き換えて、インテグレーション構成が更新されます。現在の Organization に対する以下のフィールド値を取得する方法については、Datadog-Azure インテグレーションのインストール手順を参照してください。
tenant_name [必須]:
Azure Active Directory ID
client_id [必須]:
Azure Web アプリケーション ID.
client_secret [必須]:
Azure Web アプリケーション秘密キー.
host_filters [オプション、デフォルト = None]:
タグを使用して、Datadog にプルされる Azure インスタンスを制限します。定義されたタグのいずれかに一致するホストだけが Datadog にインポートされます。
POST /v1/integration/azure
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# Create an Azure account in Datadog
curl -X POST -H "Content-type: application/json" \
-d '{
"tenant_name": "<AZURE_TENANT_NAME>",
"client_id": "<AZURE_CLIENT_ID>",
"client_secret": "<AZURE_CLIENT_SECRET>",
"host_filters": "<KEY_1>:<VALUE_1>,<KEY_2>:<VALUE_2>"
}' \
"https://api.datadoghq.com/api/v1/integration/azure?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl exampleOK特定の Datadog-Azure インテグレーションを削除します。
現在の Organization に対する以下のフィールド値を取得する方法については、Datadog-Azure インテグレーションのインストール手順を参照してください。
tenant_name [必須]:
Azure Active Directory ID
client_id [必須]:
Azure Web アプリケーション ID
host_filters [オプション、デフォルト = None]:
タグを使用して、Datadog にプルされる Azure インスタンスを制限します。定義されたタグのいずれかに一致するホストだけが Datadog にインポートされます。
DELETE /v1/integration/azure
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# Create an Azure account in Datadog
curl -X POST -H "Content-type: application/json" \
-d '{
"tenant_name": "<AZURE_TENANT_NAME>",
"client_id": "<AZURE_CLIENT_ID>",
"client_secret": "<AZURE_CLIENT_SECRET>",
"host_filters": "<KEY_1>:<VALUE_1>,<KEY_2>:<VALUE_2>"
}' \
"https://api.datadoghq.com/api/v1/integration/azure?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl exampleOK特定の Datadog-Azure インテグレーション用に定義されたホストフィルターのリストを更新します。
現在のオーガニゼーションに対する以下のフィールド値を取得する方法については、Datadog-Azure インテグレーションのインストール手順を参照してください。
tenant_name [必須]:
Azure Active Directory ID
client_id [必須]:
Azure Web アプリケーション ID
client_secret [必須]:
Azure Web アプリケーション秘密キー
host_filters [オプション、デフォルト = None]:
タグを使用して、Datadog にプルされる Azure インスタンスを制限します。定義されたタグのいずれかに一致するホストだけが Datadog にインポートされます。
POST /v1/integration/azure/host_filters
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# Create an Azure account in Datadog
curl -X POST -H "Content-type: application/json" \
-d '{
"tenant_name": "<AZURE_TENANT_NAME>",
"client_id": "<AZURE_CLIENT_ID>",
"client_secret": "<AZURE_CLIENT_SECRET>",
"host_filters": "<KEY_1>:<VALUE_1>,<KEY_2>:<VALUE_2>"
}' \
"https://api.datadoghq.com/api/v1/integration/azure?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl exampleOKGCP エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-Google Cloud Platform (GCP) インテグレーションの構成は、Datadog API から直接行います。 Datadog-Google Cloud Platform インテグレーションについては、こちらを参照してください。
現在の Organization に構成されているすべての Datadog-GCP インテグレーションをリストします。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/integration/gcp
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET "https://api.datadoghq.com/api/v1/integration/gcp?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OKDatadog-Google Cloud Platform インテグレーションを作成します。
注:
POST メソッドを使用すると、Datadog Organization の既存の構成に新しい構成を追加して、インテグレーション構成が更新されます。PUT メソッドを使用すると、現在の構成を Datadog Organization に送信された新しい構成に置き換えて、インテグレーション構成が更新されます。以下のすべてのフィールドの値は、サービスアカウントの GCP コンソールで作成された JSON サービスアカウントキーファイルから提供されます。現在の Organization に対してこのファイルを作成する方法については、Datadog-Google Cloud Platform インテグレーションのインストール手順を参照してください。 詳細については、Google Cloud のサービスアカウントキーの作成と管理に関するドキュメントを参照してください。
type [必須]:
JSON サービスアカウントキーにある service_account の値。
project_id [必須]:
JSON サービスアカウントキーにある Google Cloud プロジェクト ID。
private_key_id [必須]:
JSON サービスアカウントキーにある秘密キー ID。
private_key [必須]:
JSON サービスアカウントキーにある秘密キー名。
client_email [必須]:
JSON サービスアカウントキーにある電子メール。
client_id [必須]:
JSON サービスアカウントキーにある ID。
auth_uri [必須]:
https://accounts.google.com/o/oauth2/auth。
token_uri [必須]:
https://accounts.google.com/o/oauth2/token。
auth_provider_x509_cert_url [必須]:
https://www.googleapis.com/oauth2/v1/certs。
client_x509_cert_url [必須]:
https://www.googleapis.com/robot/v1/metadata/x509/<CLIENT_EMAIL>。ここで、<CLIENT_EMAIL> は JSON サービスアカウントキーにある電子メールです。
host_filters [オプション]:
タグを使用して、Datadog にプルされる GCE インスタンスを制限します。定義されたタグのいずれかに一致するホストだけが Datadog にインポートされます。
automute [オプション、デフォルト = false]:
予期される GCE インスタンスのシャットダウンに対してモニターをオフにします。
POST /v1/integration/gcp
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"type": "service_account",
"project_id": "<GCP_PROJECT_ID>",
"private_key_id": "<PRIVATE_KEY_ID>",
"private_key": "<PRIVATE_KEY>",
"client_email": "<CLIENT_EMAIL>",
"client_id": "<CLIENT_ID>",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://accounts.google.com/o/oauth2/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/<CLIENT_EMAIL>",
"host_filters": "<KEY_1>:<VALUE_1>,<KEY_2>:<VALUE_2>"
}' \
"https://api.datadoghq.com/api/v1/integration/gcp?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OK特定の Datadog-GCP インテグレーションを削除します。
project_id [必須]:
JSON サービスアカウントキーにある Google Cloud プロジェクト ID。
client_email [必須]:
JSON サービスアカウントキーにある電子メール。
DELETE /v1/integration/gcp
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X DELETE -H "Content-type: application/json" \
-d '{
"project_id": "<GCP_PROJECT_ID>",
"client_email": "<CLIENT_EMAIL>"
}' \
"https://api.datadoghq.com/api/v1/integration/gcp?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OK特定の Datadog-GCP インテグレーションのオートミュートを有効または無効にします。
project_id [必須]:
JSON サービスアカウントキーにある Google Cloud プロジェクト ID。
client_email [必須]:
JSON サービスアカウントキーにある電子メール。
automute [オプション、デフォルト = false]:
予期される GCE インスタンスのシャットダウンに対してモニターをオフにします。
PUT /v1/integration/gcp
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT -H "Content-type: application/json" \
-d '{
"project_id": "<GCP_PROJECT_ID>",
"client_email": "<CLIENT_EMAIL>",
"automute": <AUTOMUTE> # true or false
}' \
"https://api.datadoghq.com/api/v1/integration/gcp?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OKPagerDuty エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-PagerDuty インテグレーションの構成は、Datadog API から直接行います。 詳細については、[PagerDuty インテグレーションのページ][7]を参照してください。
Datadog-PagerDuty インテグレーションのすべての情報を取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/integration/pagerduty
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X GET \
"https://api.datadoghq.com/api/v1/integration/pagerduty?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OK新しい Datadog-PagerDuty インテグレーションを作成します。
注: 新しい PagerDuty 構成を作成 (PUT) する際は、すべての引数が必要です。
services :
PagerDuty サービスオブジェクトの配列。Datadog サービスの構成方法については、PagerDuty のドキュメントを参照してください。PagerDuty サービスオブジェクトは、以下の要素で構成されます。
service_name [必須]:
PagerDuty でのサービス名。
service_key [必須]:
Pagerduty でのサービス名に関連付けられたサービスキー。
subdomain :
PagerDuty アカウントのパーソナライズされたサブドメイン名。
schedules :
スケジュール URL の配列。例:
["https://my-pd.pagerduty.com/schedules#PCPYT4M", "https://my-pd.pagerduty.com/schedules#PKTPB7P"]
api_token :
PagerDuty API トークン。
PUT /v1/integration/pagerduty
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X PUT -H "Content-type: application/json" \
-d '{
"services": [
{
"service_name": "<SERVICE_NAME_1>",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
},
{
"service_name": "<SERVICE_NAME_2>",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
}
],
"subdomain": "<PAGERDUTY_SUB_DOMAIN>",
"schedules": ["<SCHEDULE_1>", "<SCHEDULE_2>"],
"api_token": "<PAGERDUTY_TOKEN>"
}' \
"https://api.datadoghq.com/api/v1/integration/pagerduty?api_key=${api_key}&application_key=${app_key}"# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OKDatadog-PagerDuty インテグレーションに新しいサービスとスケジュールを追加します。
services :
PagerDuty サービスオブジェクトの配列。Datadog サービスの構成方法については、PagerDuty のドキュメントを参照してください。PagerDuty サービスオブジェクトは、以下の要素で構成されます。
service_name [必須]:
PagerDuty でのサービス名。
service_key [必須]:
Pagerduty でのサービス名に関連付けられたサービスキー。
schedules :
スケジュール URL の配列:
["https://my-pd.pagerduty.com/schedules#PCPYT4M", "https://my-pd.pagerduty.com/schedules#PKTPB7P"]
POST /v1/integration/pagerduty
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X POST -H "Content-type: application/json" \
-d '{
"services": [
{
"service_name": "test_00",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
},
{
"service_name": "test_01",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
}
],
"schedules": ["<SCHEDULE_1>", "<SCHEDULE_2>"],
}' \
"https://api.datadoghq.com/api/v1/integration/pagerduty?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OKDatadog-PagerDuty インテグレーションを削除します。
このエンドポイントは、JSON 引数を受け取りません。
DELETE /v1/integration/pagerduty
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X DELETE \
"https://api.datadoghq.com/api/v1/integration/pagerduty?api_key=${api_key}&application_key=${app_key}"# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OKSlack エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-Slack インテグレーションの構成は、Datadog API から直接行います。 Datadog-Slack インテグレーションの詳細については、インテグレーションページを参照してください。
Datadog-Slack インテグレーションのすべての情報を取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/integration/slack
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X GET "https://api.datadoghq.com/api/v1/integration/slack?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OK
Datadog-Slack インテグレーションを作成します。
注:
POST メソッドを使用すると、Datadog Organization の既存の構成に新しい構成を追加して、インテグレーション構成が更新されます。PUT メソッドを使用すると、現在の構成を Datadog Organization に送信された新しい構成に置き換えて、インテグレーション構成が更新されます。service_hooks [必須]:
サービスフックオブジェクトの配列 (Slack アカウントのサービスフックは Slack アカウント管理ページで生成されます)。サービスフックオブジェクトは、以下の要素で構成されます。
account [必須]:
Slack アカウント名。
url [必須]:
Slack サービスフックの URL。
注: 既存の Slack 構成に追加 (POST) または更新 (PUT) する際に、ペイロードに service_hooks は必要ありません。
POST /v1/integration/slack
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X POST -H "Content-type: application/json" \
-d '{
"service_hooks": [
{
"account": "Main_Account",
"url": "https://hooks.slack.com/services/1/1/1"
},
{
"account": "doghouse",
"url": "https://hooks.slack.com/services/2/2/2"
}
]
}' \
"https://api.datadoghq.com/api/v1/integration/slack?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OK
Add channels to your Datadog-Slack integration.
channels [required]:
The array of slack channel objects to post to. A slack channel object is composed by:
channel_name [required]:
Your channel name e.g: #general, #private
transfer_all_user_comments [optional, default=False]:
To be notified for every comment on a graph, set it to true. If set to False use the @slack-channel_name syntax for comments to be posted to slack.
account [required]:
Account to which the channel belongs to.
POST /v1/integration/slack
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"channels": [
{
"channel_name": "#channel_name_main_account",
"transfer_all_user_comments": "false",
"account": "Main_Account"
},
{
"channel_name": "#channel_name_doghouse",
"transfer_all_user_comments": "false",
"account": "doghouse"
}
]
}' \
"https://api.datadoghq.com/api/v1/integration/slack?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OK
Delete a Datadog-Slack integration.
This endpoint takes no JSON arguments.
DELETE /v1/integration/slack
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X DELETE "https://api.datadoghq.com/api/v1/integration/slack?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OK
Webhooks エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-Webhooks インテグレーションの構成は、Datadog API から直接行います。 Datadog-Webhooks インテグレーションの詳細については、インテグレーションページを参照してください。
Datadog-Webhooks インテグレーションのすべての情報を取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/integration/webhooks
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X GET "https://api.datadoghq.com/api/v1/integration/webhooks?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OKDatadog-Webhooks インテグレーションを作成します。
注:
POST メソッドを使用すると、Datadog Organization の既存の構成に新しい構成を追加して、インテグレーション構成が更新されます。hooks [必須]:
Webhook オブジェクトの配列。Webhook オブジェクトは、以下の要素で構成されます。
name [必須]:
Webhook 名。
モニター通知で使用する方法については、こちらを参照してください。url [必須]:
Webhook の URL。use_custom_payload [オプション、デフォルト = False]:
true の場合は、Webhook にカスタムペイロードを指定することができます。
custom_payload [オプション、デフォルト = None]:
use_custom_payload が true の場合は、独自のペイロードを指定し、これらの変数を使用してリクエストに独自のカスタムフィールドを追加します。
encode_as_form [オプション、デフォルト = False]:
use_custom_payload が true の場合に、これを true に設定すると、ペイロードが URL エンコードされます。
headers [オプション、デフォルト = None]:
Webhook にアタッチされるヘッダー。
POST /v1/integration/webhooks
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X POST -H "Content-type: application/json" \
-d '{
"hooks": [
{
"name": "<WEBHOOK_NAME>",
"url": "<WEBHOOK_URL>",
"use_custom_payload": "false",
"encode_as_form": "false"
}
]
}' \
"https://api.datadoghq.com/api/v1/integration/webhooks?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OK特定の Webhook を Datadog Webhooks インテグレーションに追加します。
hooks [必須]:
Webhook オブジェクトの配列。Webhook オブジェクトは、以下の要素で構成されます。
name [必須]:
Webhook 名。
モニター通知で使用する方法については、こちらを参照してください。url [必須]:
Webhook の URL。use_custom_payload [オプション、デフォルト = False]:
true の場合は、Webhook にカスタムペイロードを指定することができます。
custom_payload [オプション、デフォルト = None]:
use_custom_payload が true の場合は、独自のペイロードを指定し、これらの変数を使用してリクエストに独自のカスタムフィールドを追加します。
encode_as_form [オプション、デフォルト = False]:
use_custom_payload が true の場合に、これを true に設定すると、ペイロードが URL エンコードされます。
headers [オプション、デフォルト = None]:
Webhook にアタッチされるヘッダー。
POST /v1/integration/webhooks
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X POST -H "Content-type: application/json" \
-d '{
"hooks": [
{
"name": "<WEBHOOK_NAME>",
"url": "<WEBHOOK_URL>"
}
]
}' \
"https://api.datadoghq.com/api/v1/integration/webhooks?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OKDelete a given Datadog-Webhooks integration.
This endpoint takes no JSON arguments.
DELETE /v1/integration/webhooks
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X DELETE "https://api.datadoghq.com/api/v1/integration/webhooks?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OKKey Management エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
DatadogのAPIとアプリケーションキーを管理
このエンドポイントを使用するには、API キーおよびアプリケーションキーと共に管理者権限が必要です。
すべてのキーのリストは Datadog API ページで参照できます。
現在のアカウントで利用できるすべての API キーを取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/api_key/
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
"https://app.datadoghq.com/api/v1/api_key?api_key=${api_key}}&application_key=${app_key}" \
-H 'Content-Type: application/json'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"api_keys": [
{
"created_by": "john@example.com",
"name": "<API_KEY_NAME>",
"key": "1111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:20:30"
},
{
"created_by": "jane@example.com",
"name": "<APP_KEY_NAME_2>",
"key": "2111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:19:53"
}
]
}
特定の API キーを取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/api_key/<API_KEY>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
"https://app.datadoghq.com/api/v1/api_key/<API_KEY_TO_GET>?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"api_key": {
"created_by": "john@example.com",
"name": "<API_KEY_NAME>",
"key": "3111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:47:00"
}
}
名前を指定して API キーを作成します。
name [必須]:
API キーの名前。
POST /v1/api_key/<API_KEY>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
"https://app.datadoghq.com/api/v1/api_key?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json' \
-d '{
"name": "<API_KEY_NAME>"
}'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"api_key": {
"created_by": "john@example.com",
"name": "<API_KEY_NAME>",
"key": "3111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:47:00"
}
}
API キーの名前を編集します。
name [必須]:
API キーの名前。
PUT /v1/api_key/<API_KEY>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT \
"https://app.datadoghq.com/api/v1/api_key/<API_KEY_TO_EDIT>?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json' \
-d '{
"name":"<NEW_API_KEY_NAME>"
}'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"api_key": {
"created_by": "john@example.com",
"name": "<API_KEY_NAME>",
"key": "3111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:47:00"
}
}
特定の API キーを削除します。
このエンドポイントは、JSON 引数を受け取りません。
DELETE /v1/api_key/<API_KEY>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X DELETE \
"https://app.datadoghq.com/api/v1/api_key/<API_KEY_TO_DELETE>?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"api_key": {
"created_by": "john@example.com",
"name": "<API_KEY_NAME>",
"key": "3111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:47:00"
}
}
現在のアカウントで利用できるすべてのアプリケーションキーを取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/application_key/
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
"https://app.datadoghq.com/api/v1/application_key?api_key=${api_key}}&application_key=${app_key}" \
-H 'Content-Type: application/json'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"application_keys": [
{
"owner": "john@example.com",
"hash": "11111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<APP_KEY_NAME>"
},
{
"owner": "jane@example.com",
"hash": "21111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<APP_KEY_NAME_2>"
}
]
}
特定のアプリケーションキーを取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/application_key/<APP_KEY>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
"https://app.datadoghq.com/api/v1/application_key/<APP_KEY_TO_GET>?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"application_key": {
"owner": "john@example.com",
"hash": "31111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<APP_KEY_NAME>"
}
}
名前を指定してアプリケーションキーを作成します。
name [必須]:
アプリケーションキーの名前。
POST /v1/application_key/<APP_KEY>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
"https://app.datadoghq.com/api/v1/application_key?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json' \
-d '{
"name": "<APP_KEY_NAME>"
}'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"application_key": {
"owner": "john@example.com",
"hash": "31111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<APP_KEY_NAME>"
}
}
アプリケーションキーの名前を編集します。
name [必須]:
アプリケーションキーの名前。
PUT /v1/application_key/<APP_KEY>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT \
"https://app.datadoghq.com/api/v1/application_key/<APP_KEY_TO_EDIT>?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json' \
-d '{
"name":"<NEW_APP_KEY_NAME>"
}'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"application_key": {
"owner": "john@example.com",
"hash": "31111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<NEW_APP_KEY_NAME>"
}
}
特定のアプリケーションキーを削除します。
このエンドポイントは、JSON 引数を受け取りません。
DELETE /v1/application_key/<APP_KEY>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X DELETE \
"https://app.datadoghq.com/api/v1/application_key/<APP_KEY_TO_DELETE>?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"application_key": {
"owner": "john@example.com",
"hash": "31111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<APP_KEY_NAME>"
}
}
Logs エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
HTTP を使用して Datadog プラットフォームにログを送信します。HTTP リクエストごとの制限は以下のとおりです。
注: Datadog EU サイト (app.datadoghq.eu) の場合、HTTP ログのエンドポイントは http-intake.logs.datadoghq.eu です。
| Item | Description |
|---|---|
| Protocol | http: 80 https: 443 |
| Host | For Datadog US: http-intake.logs.datadoghq.comFor Datadog EU: http-intake.logs.datadoghq.eu |
| Path | /v1/input/<DATADOG_API_KEY> |
| Query parameters | Query parameters available are the reserved log attribute. ?ddtags=<TAGS>&ddsource=<SOURCE>&service=<SERVICE>&hostname=<HOSTNAME> |
| Method | POST |
| Content Type | Available content type are: text/plain, application/json, application/logplex-1 |
https://http-intake.logs.datadoghq.com/v1/input/<DATADOG_API_KEY>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
## Simple Raw Message
## Log attributes can be passed as query parameters
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY>?ddtags=env:prod,user:my-user \
-H "Content-Type: text/plain" \
-d 'hello world'
## Multi Raw Messages
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY> \
-H "Content-Type: text/plain" \
--data-binary @- <<BODY
hello
world
BODY
## Simple JSON Message
## Log attributes can also be passed as key:value pairs in valid JSON messages
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY> \
-H "Content-Type: application/json" \
-d '{"message":"hello world", "ddsource":"<SOURCE>", "ddtags":"env:<ENV>,user:<USER_NAME>", "hostname":"<HOSTNAME>"}'
## Multi JSON Messages
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY> \
-H "Content-Type: application/json" \
--data-binary @- <<BODY
[
{
"message": "hello"
},
{
"message": "world"
}
]
BODY
## Simple Logplex Message
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY> \
-H "Content-Type: application/logplex-1" \
-d 'hello world'
## Multi Logplex Messages
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY> \
-H "Content-Type: application/logplex-1" \
--data-binary @- <<BODY
hello
world
BODY
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}リストエンドポイントは、ログ検索クエリと一致するログを返します。結果はページ区切りされます。
オーガニゼーションのためのログのアーカイブを目的とする場合は、ログリスト API の代わりに Datadog のアーカイブ機能を使用することを検討してください。Datadog のログのアーカイブに関するドキュメントを参照してください。
query [必須]:
検索クエリ - ログ検索構文に従います。time.from [必須]:
リクエストされたログの最小タイムスタンプ。以下のいずれかの形式です。now -10m、now - 1h、now - 1d)time.to [必須]:
リクエストされたログの最大タイムスタンプ。以下のいずれかの形式です。now、now -10m、now - 1h、now - 1d)time.timezone [オプション、デフォルト = None]:
オフセット (例: 「”UTC+03:00」) または地域ゾーン (例: 「Europe/Paris」) で指定できます。time.offset [オプション、デフォルト = None]:
秒単位の値であること以外は time.timezone と同じです。
タイムゾーンとオフセットの両方が指定された場合、タイムゾーンは無視されます。startAt [オプション、デフォルト = None]:
リストで返される最初のログのハッシュ識別子 (ログの id 属性)。このパラメーターは、ページ区切り機能で使用されます。
注: 対応するログが、指定されたタイムウィンドウの範囲外の場合、このパラメーターは無視されます。sort [オプション、デフォルト = desc]:
結果が時間の古い順の場合は asc、新しい順の場合は desc。limit [オプション、デフォルト = 10]:
応答で返されるログの数 (最大 1000)。index [オプション、デフォルト = main]:
マルチインデックスのオーガニゼーションの場合に、リクエストが実行されるログインデックス。POST api/v1/logs-queries/list
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
"https://api.datadoghq.com/api/v1/logs-queries/list?api_key=${api_key}&application_key=${app_key}" \
-H 'content-type: application/json' \
-d '{"query": "service:nginx -@http.method:POST","time": {"from": "now - 1h", "to": "now"}, "sort": "desc", "limit": 50}'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
logs: [{
id: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA",
content: {
timestamp: "2019-01-02T09:42:36.320Z",
tags: ['team:A'],
attributes: {
customAttribute: 123,
duration: 2345
},
host: 'i-123',
service: 'agent',
message: 'host connected to remote'
}
}],
nextLogId: "BBBBWgn...",
status: "ok"
}Index オブジェクトはログインデックスの構成を記述します。次の属性を持ちます。
name (読み取り専用):
インデックスの名前。filter.query :
このインデックスでは、フィルター条件に一致するログだけが考慮されます。
検索クエリはログ検索構文に従います。num_retention_days (読み取り専用):
このインデックスからログが削除されるまでの日数。daily_limit (読み取り専用):
レート制限されるまでに、このインデックスで送信できるログイベントの数。is_rate_limited (読み取り専用):
インデックスがレート制限されているかどうかを示すブール値。レート制限は、1 日の上限を超えるログが送信されたことを意味します。レート制限は毎日 UTC 午後 2 時にリセットされます。exclusion_filters
ExclusionFilter オブジェクトの配列 (以下を参照)。ログは、配列の順序に従い、各 ExclusionFilter のクエリに照らしてテストされます。最初に一致したアクティブな ExclusionFilter だけが適用され、他のフィルターは一致しても無視されます。
name :
除外フィルターの名前。is_enabled :
除外がアクティブ (最終的にログを除外する) かどうかを示すブール値。filter.query :
フィルター条件と親インデックスのクエリの両方に一致するログだけがこの除外フィルターで考慮されます。
検索クエリはログ検索構文に従います。filter.sample_rate :
この除外フィルターがアクティブな場合に除外されるログの割合。サンプリングは均一です。注: このエンドポイントを使用するには、API キーおよびアプリケーションキーと共に管理者権限が必要です。
このエンドポイントはオーガニゼーションの Index オブジェクトの配列を返します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/logs/config/indexes/
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
"https://api.datadoghq.com/api/v1/logs/config/indexes?api_key=${api_key}&application_key=${app_key}" \
-H 'content-type: application/json'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"indexes": [
{
"name": "<INDEX_NAME>",
"filter": {
"query": "<INDEX_FILTER_QUERY>"
},
"num_retention_days": 15,
"daily_limit": 150000000,
"is_rate_limited": false,
"exclusion_filters": [
{
"name": "<INDEX_EXCLUSTION_FILTER_1>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY>",
"sample_rate": 1
}
}
]
}
]
}
このエンドポイントは、名前で識別された Index を返します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/logs/config/indexes/<INDEX_NAME>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
"https://api.datadoghq.com/api/v1/logs/config/indexes/<INDEX_NAME>?api_key=${api_key}&application_key=${app_key}" \
-H 'content-type: application/json'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"name": "<INDEX_NAME>",
"filter": {
"query": "<INDEX_FILTER_QUERY>"
},
"num_retention_days": 15,
"daily_limit": 150000000,
"is_rate_limited": false,
"exclusion_filters": [
{
"name": "<INDEX_EXCLUSTION_FILTER_1>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY>",
"sample_rate": 1
}
}
]
}
This endpoint updates an Index identified by its name. It returns the Index object passed in the request body when the request is successful.
filter.query [optional]:
Only logs matching the filter criteria will be considered for this index. The search query followis the Log search syntaxexclusion_filters An array of ExclusionFilter objects (see hereafter). The logs are tested against the query of each ExclusionFilter, following the order of the array. Only the first matching active ExclusionFilter matters, others (if any) are ignored. The ExclusionFilter object describes the configuration of an exclusion filter. It has the following attributes:
name [required]:
The name of the exclusion filteris_enabled [optional, default=False]:
A boolean stating if the exclusion is active.filter.query [optional]:
Only logs matching the filter criteria AND the query of the parent index will be considered for this exclusion filter. The search query follows the Log search syntaxfilter.sample_rate [required]:
The fraction of logs excluded by the exclusion filter, when active. The sampling is uniform.PUT /v1/logs/config/indexes/<INDEX_NAME>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT \
"https://api.datadoghq.com/api/v1/logs/config/indexes/<INDEX_NAME>?api_key=${api_key}&application_key=${app_key}" \
-H 'content-type: application/json' \
-d '{
"filter": {
"query": "<NEW_INDEX_FILTER_QUERY>"
},
"exclusion_filters": [
{
"name": "<INDEX_EXCLUSTION_FILTER_1>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY>",
"sample_rate": 1
}
},
{
"name": "<INDEX_EXCLUSTION_FILTER_2>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY_2>",
"sample_rate": 1
}
}
]
}'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"name": "<INDEX_NAME>",
"filter": {
"query": "<NEW_INDEX_FILTER_QUERY>"
},
"num_retention_days": 15,
"daily_limit": 150000000,
"is_rate_limited": false,
"exclusion_filters": [
{
"name": "<INDEX_EXCLUSTION_FILTER_1>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY>",
"sample_rate": 1
}
},
{
"name": "<INDEX_EXCLUSTION_FILTER_2>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY_2>",
"sample_rate": 1
}
}
]
}
インデックス順序エンドポイントを使用して、オーガニゼーションのインデックスの処理順序を制御します。このエンドポイントは、オーガニゼーションのログに 1 つ以上のインデックスがある場合にのみ使用します。このインデックスを使用してインデックスの追加や削除を行うことはできません。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/logs/config/index-order
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
"https://api.datadoghq.com/api/v1/logs/config/index-order?api_key=${api_key}&application_key=${app_key}" \
-H 'content-type: application/json'# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"index_names": [
"<INDEX_NAME_1>",
"<INDEX_NAME_2>"
]
}
このエンドポイントは、オーガニゼーションの IndexOrder を更新します。リクエストが正常に完了したときに、リクエスト本文で渡される IndexOrder オブジェクトを返します。
index_names [必須]: オーガニゼーションのインデックスを名前で識別する文字列の配列。ログは、配列の順序に従い、各インデックスのクエリフィルターに照らして 1 つずつテストされます。最終的に、ログは最初に一致したインデックスに保存されます。PUT /v1/logs/config/index-order
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT \
"https://api.datadoghq.com/api/v1/logs/config/index-order?api_key=${api_key}&application_key=${app_key}" \
-H 'content-type: application/json' \
-d '{
"index_names": [
"<INDEX_NAME_2>",
"<INDEX_NAME_1>"
]
}'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"index_names": [
"<INDEX_NAME_2>",
"<INDEX_NAME_1>"
]
}
Logs Pipelines エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
パイプラインとプロセッサーは、受信ログに対して操作を行い、ログをパースして構造化属性に変換することで、クエリを容易に行えるようにします。
注: これらのエンドポイントを使用できるのは、管理者ユーザーだけです。管理者によって作成されたアプリケーションキーを使用してください。
パイプラインの現在の順序を取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/logs/config/pipeline-order
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET "https://api.datadoghq.com/api/v1/logs/config/pipeline-order?api_key=${api_key}&application_key=${app_key}"
パイプラインの順序を更新します。
注: ログは順番に処理されます。パイプラインの順序を変更すると、他のパイプラインやそのプロセッサーによって処理されるデータの構造や内容が変化する可能性があります。
pipeline_ids [必須]:
<PIPELINE_ID> 文字列の順序付き配列。配列内のパイプライン ID の順序は、Datadog のパイプライン全体の順序を定義します。PUT /v1/logs/config/pipeline-order
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT "https://api.datadoghq.com/api/v1/logs/config/pipeline-order?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json' \
-d '{
"pipeline_ids": [
"<PIPELINE_1_ID>",
"<PIPELINE_2_ID>",
"<PIPELINE_3_ID>"
]
}'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"pipeline_ids": [
"<PIPELINE_1_ID>",
"<PIPELINE_2_ID>",
"<PIPELINE_3_ID>"
]
}
オーガニゼーションからすべてのパイプラインを取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/logs/config/pipelines
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
[
{
"id": "<PIPELINE_1_ID>",
"type": "pipeline",
"name": "<PIPELINE_1_NAME>",
"is_enabled": false,
"is_read_only": true,
"filter": {
"query": "<PIPELINE_1_FILTER>"
},
"processors": ["<PROCESSOR_PIPELINE_1ARRAY>"
]
},
{
"id": "<PIPELINE_2_ID>",
"type": "pipeline",
"name": "<PIPELINE_2_NAME>",
"is_enabled": false,
"is_read_only": true,
"filter": {
"query": "<PIPELINE_2_FILTER>"
},
"processors": ["<PROCESSOR_PIPELINE_2_ARRAY>"
]
}
]
オーガニゼーションから特定のパイプラインを取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/logs/config/pipelines/<PIPELINE_ID>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
pipeline_id=<PIPELINE_ID>
curl -X GET "https://api.datadoghq.com/api/v1/logs/config/${pipeline_id}?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"id": "<PIPELINE_ID>",
"type": "pipeline",
"name": "<PIPELINE_NAME>",
"is_enabled": false,
"is_read_only": true,
"filter": {
"query": "<PIPELINE_FILTER>"
},
"processors": [
{
"name": "<PROCESSOR_1_NAME>",
"is_enabled": true,
"source": "message",
"grok": {
"support_rules": "",
"match_rules": "<MATCHED_RULES>"
},
"type": "grok-parser"
},
{
"name": "Define timestamp as the official timestamp of the log",
"is_enabled": true,
"sources": [
"timestamp"
],
"type": "date-remapper"
},
{
"name": "Define level as the official log status",
"is_enabled": true,
"sources": [
"level"
],
"type": "status-remapper"
}
]
}
オーガニゼーションにパイプラインを作成します。
name [必須]:
パイプラインの名前。
is_enabled [オプション、デフォルト = False]:
パイプラインを有効にするためのブール値。
filter.query [オプション]: パイプラインフィルターを定義します。フィルター条件と一致するログだけが、このパイプラインによって処理されます。
processors [オプション]: プロセッサーまたはネストされたパイプラインの順序付き配列。プロセッサーごとのスキームの取得については、プロセッサーに関するドキュメントを参照してください。
POST /v1/logs/config/pipelines
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
"https://api.datadoghq.com/api/v1/logs/config/pipelines?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json' \
-d '{
"name": "<PIPELINE_NAME>",
"is_enabled": true,
"filter": {
"query": "<PIPELINE_QUERY>"
},
"processors": [
{
"name": "Define date as the official timestamp of the log",
"is_enabled": true,
"sources": [
"date"
],
"type": "date-remapper"
}
]
}'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"id": "7fKHTENgSkyGoJcCDbem-g",
"type": "pipeline",
"name": "<PIPELINE_NAME>",
"is_enabled": true,
"is_read_only": false,
"filter": {
"query": "<PIPELINE_QUERY>"
},
"processors": [
{
"name": "Define date as the official timestamp of the log",
"is_enabled": true,
"sources": [
"date"
],
"type": "date-remapper"
}
]
}
Update a given pipeline configuration to change it’s processors or their order.
name [required]:
Your pipeline name.
is_enabled [optional, default=False]:
Boolean value to enable your pipeline.
filter.query [optional]: Defines your pipeline filter. Only logs that match the filter criteria are processed by this pipeline.
processors [optional]: Ordered array of processors or nested pipelines. See the Processor documentation to get the specific scheme for each processor.
PUT /v1/logs/config/pipelines/<PIPELINE_ID>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
pipeline_id=<PIPELINE_ID>
curl -X PUT \
"https://api.datadoghq.com/api/v1/logs/config/pipelines/${pipeline_id}?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json' \
-d '{
"name": "<NEW_PIPELINE_NAME>",
"is_enabled": true,
"filter": {
"query": "<NEW_PIPELINE_QUERY>"
},
"processors": [
{
"name": "Define date as the official timestamp of the log",
"is_enabled": true,
"sources": [
"date"
],
"type": "date-remapper"
}
]
}'
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"id": "<PIPELINE_ID>",
"type": "pipeline",
"name": "<NEW_PIPELINE_NAME>",
"is_enabled": true,
"is_read_only": false,
"filter": {
"query": "<NEW_PIPELINE_QUERY>"
},
"processors": [
{
"name": "Define date as the official timestamp of the log",
"is_enabled": true,
"sources": [
"date"
],
"type": "date-remapper"
}
]
}
指定されたパイプラインをオーガニゼーションから削除します。
このエンドポイントは、JSON 引数を受け取りません。
DELETE /v1/logs/config/pipelines
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
pipeline_id=<PIPELINE_ID>
curl -X DELETE "https://api.datadoghq.com/api/v1/logs/config/pipelines/${pipeline_id}?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}メトリクスエンドポイントを使用して、以下を行うことができます。
Datadog の UI に表示されるグラフには、一定数のポイントしか含まれず、表示されているメトリクスのタイムフレームが長くなると、その一定数以下にポイントを抑えるために、ポイント間の集約が行われます。
したがって、クエリするデータのタイムフレームが長くなるほど、返されるポイントの集約度は高くなります。Datadog での最高粒度は 1 ポイント/秒です。この間隔 (1 秒) でポイントを送信し、ごく短い時間 (この場合はおよそ 100 秒未満) をクエリ API にリクエストすれば、送信したポイントがすべてそのまま返されます。そうでない場合、Datadog のアルゴリズムは、指定されたタイムウィンドウごとに約 150 個のポイントを返そうとするため、リクエストされた時間が長くなるほど、粒度の粗いデータが表示されることになります。この時間集計は平均化によって行われます。
メトリクスポイントは 1 秒の解像度で保存されますが、ポイントの送信は 15 秒間隔で行うことをお勧めします。 1 秒未満のタイムスタンプを持つメトリクスは、最も近い秒単位に丸められます。また、同じタイムスタンプを持つポイントが複数ある場合は、最新のポイントによって以前のポイントが上書きされます。
Datadog では、1 ホストあたり 100 個の時系列というソフト制限を設けています。 メトリクス名とタグの一意の組み合わせが 1 つの時系列になります。
このエンドポイントは、Datadog の Ruby クライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
特定の時間から現在までアクティブに報告しているメトリクスのリストを取得します。Python および Ruby ライブラリでは、このエンドポイントを使用できません。
from [必須]:
Unix Epoch 以降の秒数host [オプション]:
返されるメトリクスのリストを絞り込むためのホスト名。設定した場合は、対応するホスト名タグを持つメトリクスが取得されます。GET /v1/metrics
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Taking the last 24hours
from_time = int(time.time()) - 60 * 60 * 24 * 1
result = api.Metric.list(from_time)
print(result)
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
from_time=$(date -v -1d +%s)
curl -G \
"https://api.datadoghq.com/api/v1/metrics" \
-d "api_key=${api_key}" \
-d "application_key=${app_key}" \
-d "from=${from_time}" \
-d "host=<HOSTNAME>"
{
"metrics": [
"system.load.1",
"system.load.15",
"system.load.5",
"system.load.norm.1",
"system.load.norm.15",
"system.load.norm.5",
"system.mem.buffered",
"system.mem.cached",
"system.mem.committed",
"system.mem.free"
],
"from": 1467815773
}
{
"metrics": [
"system.load.1",
"system.load.15",
"system.load.5",
"system.load.norm.1",
"system.load.norm.15",
"system.load.norm.5",
"system.mem.buffered",
"system.mem.cached",
"system.mem.committed",
"system.mem.free"
],
"from": 1467815773
}{
"metrics": [
"system.load.1",
"system.load.15",
"system.load.5",
"system.load.norm.1",
"system.load.norm.15",
"system.load.norm.5",
"system.mem.buffered",
"system.mem.cached",
"system.mem.committed",
"system.mem.free"
],
"from": 1467815773
}メトリクスエンドポイントを使用して、Datadog のダッシュボードでグラフ化できる時系列データをポストできます。圧縮ペイロードの上限は 3.2 メガバイト (3200000)、非圧縮ペイロードでは 62 メガバイト (62914560) です。
series [必須]:
配列内の各項目に次の引数が含まれる JSON 配列を渡します。
metric [必須]:
時系列の名前。type [オプション、デフォルト = gauge]:
メトリクスのタイプ。gauge、rate、count のいずれかです。interval [オプション、デフォルト = None]:
メトリクスのタイプが rate または count の場合に、該当する間隔を定義します。points [必須]:
ポイントの JSON 配列。各ポイントは次の形式になります。
[[POSIX_timestamp, numeric_value], ...]
注: タイムスタンプは現在の秒です。数値の形式は 32 ビット浮動小数点ゲージタイプ値です。
「現在」は、その時点の 10 分先から過去 1 時間以内の時間と定義されます。host [オプション]:
メトリクスを生成したホストの名前。tags [オプション、デフォルト = None]:
メトリクスに関連付けられているタグのリスト。POST /v1/series
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>'
}
initialize(**options)
now = time.time()
future_10s = now + 10
# Submit a single point with a timestamp of `now`
api.Metric.send(metric='page.views', points=1000)
# Submit a point with a timestamp (must be ~current)
api.Metric.send(metric='my.pair', points=(now, 15))
# Submit multiple points.
api.Metric.send(
metric='my.series',
points=[
(now, 15),
(future_10s, 16)
]
)
# Submit a point with a host and tags.
api.Metric.send(
metric='my.series',
points=100,
host="myhost.example.com",
tags=["version:1"]
)
# Submit multiple metrics
api.Metric.send([{
'metric': 'my.series',
'points': 15
}, {
'metric': 'my1.series',
'points': 16
}])
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
dog = Dogapi::Client.new(api_key)
# Submit one metric value.
dog.emit_point('some.metric.name', 50.0, :host => "my_host.example.com")
# Submit multiple metric values
points = [
[Time.now, 0],
[Time.now + 10, 10.0],
[Time.now + 20, 20.0]
]
dog.emit_points('some.metric.name', points, :tags => ["version:1"])
# Emit differents metrics in a single request to be more efficient
dog.batch_metrics do
dog.emit_point('test.api.test_metric',10)
dog.emit_point('test.api.this_other_metric', 1)
end
currenttime=$(date +%s)
curl -X POST -H "Content-type: application/json" \
-d "{ \"series\" :
[{\"metric\":\"test.metric\",
\"points\":[[$currenttime, 20]],
\"type\":\"rate\",
\"interval\": 20,
\"host\":\"test.example.com\",
\"tags\":[\"environment:test\"]}
]
}" \
"https://api.datadoghq.com/api/v1/series?api_key=<YOUR_API_KEY>"
このエンドポイントを使用して、任意の期間のメトリクスをクエリできます。クエリからグラフまでで説明されているクエリ構文を使用してください。
注: Python では、from は予約語です。そのため、Python API では、代わりに関数呼び出しで start パラメーターと end パラメーターを使用します。
from [Python 以外では必須]:
Unix Epoch からの秒数to [Python 以外では必須]:
Unix Epoch からの秒数start [Python では必須、デフォルト = None]:
Unix Epoch 以降の秒数end [Python では必須、デフォルト = None]:
Unix Epoch 以降の秒数query [必須]:
クエリ文字列GET /v1/query
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
now = int(time.time())
query = 'system.cpu.idle{*}by{host}'
print api.Metric.query(start=now - 3600, end=now, query=query)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get points from the last hour
from = Time.now - 3600
to = Time.now
query = 'system.cpu.idle{*}by{host}'
dog.get_points(query, from, to)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
to_time=$(date +%s)
from_time=$(date -v -1d +%s)
curl -G \
"https://api.datadoghq.com/api/v1/query" \
-d "api_key=${api_key}" \
-d "application_key=${app_key}" \
-d "from=${from_time}" \
-d "to=${to_time}" \
-d "query=system.cpu.idle{*}by{host}"
{
'status': 'ok',
'res_type': 'time_series',
'series': [{
'end': 1430313599000,
'metric': 'system.cpu.idle',
'interval': 30,
'start': 1430312070000,
'length': 10,
'aggr': None,
'attributes': {},
'pointlist': [
[1430312070000.0, 75.08000183105469],
[1430312100000.0, 99.33000183105469],
[1430312130000.0, 99.83499908447266],
[1430312160000.0, 100.0],
[1430312190000.0, 99.66999816894531],
[1430312220000.0, 100.0],
[1430312250000.0, 99.83499908447266],
[1430312280000.0, 99.66999816894531],
[1430312310000.0, 99.83499908447266],
[1430312340000.0, 99.66999816894531]
],
'expression': 'system.cpu.idle{host:vagrant-ubuntu-trusty-64}',
'scope': 'host:vagrant-ubuntu-trusty-64',
'unit': None,
'display_name': 'system.cpu.idle'
}],
'from_date': 1430309983000,
'group_by': ['host'],
'to_date': 1430313583000,
'query': 'system.cpu.idle{*}by{host}',
'message': u''
}
{
'status' => 'ok',
'res_type' => 'time_series',
'series' => [{
'end' => 1430313599000,
'metric' => 'system.cpu.idle',
'interval' => 30,
'start' => 1430312070000,
'length' => 10,
'aggr' => nil,
'attributes' => {},
'pointlist' => [
[1430312070000.0, 75.08000183105469],
[1430312100000.0, 99.33000183105469],
[1430312130000.0, 99.83499908447266],
[1430312160000.0, 100.0],
[1430312190000.0, 99.66999816894531],
[1430312220000.0, 100.0],
[1430312250000.0, 99.83499908447266],
[1430312280000.0, 99.66999816894531],
[1430312310000.0, 99.83499908447266],
[1430312340000.0, 99.66999816894531]
],
'expression' => 'system.cpu.idle{host:vagrant-ubuntu-trusty-64}',
'scope' => 'host:vagrant-ubuntu-trusty-64',
'unit' => nil,
'display_name' => 'system.cpu.idle'
}],
'from_date' => 1430309983000,
'group_by' => ['host'],
'to_date' => 1430313583000,
'query' => 'system.cpu.idle{*}by{host}',
'message' => ''
}{
"status": "ok",
"res_type": "time_series",
"series": [
{
"metric": "system.cpu.idle",
"attributes": {},
"display_name": "system.cpu.idle",
"unit": null,
"pointlist": [
[
1430311800000,
98.19375610351562
],
[
1430312400000,
99.85856628417969
]
],
"end": 1430312999000,
"interval": 600,
"start": 1430311800000,
"length": 2,
"aggr": null,
"scope": "host:vagrant-ubuntu-trusty-64",
"expression": "system.cpu.idle{host:vagrant-ubuntu-trusty-64}"
}
],
"from_date": 1430226140000,
"group_by": [
"host"
],
"to_date": 1430312540000,
"query": "system.cpu.idle{*}by{host}",
"message": ""
}メトリクスメタデータエンドポイントを使用して、特定のメトリクスに関するメタデータを取得できます。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/metrics/<METRIC_NAME>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
metric = 'system.cpu.idle'
api.Metadata.get(metric_name=metric)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get metadata on metric
result = dog.get_metadata('system.net.bytes_sent')
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
metric_name="system.net.bytes_sent"
curl "https://api.datadoghq.com/api/v1/metrics/${metric_name}?api_key=${api_key}&application_key=${app_key}"
{
'description': 'Percent of time the CPU spent in an idle state.',
'short_name': 'cpu idle',
'integration': 'system',
'statsd_interval': None,
'per_unit': None,
'type': 'gauge',
'unit': 'percent'
}
{
"description" => "Percent of time the CPU spent in an idle state.",
"short_name" => "cpu idle",
"integration" => "system",
"statsd_interval" => nil,
"per_unit" => nil,
"type" => "gauge",
"unit" => "percent"
}{
"description": "My custom description",
"short_name":"bytes sent",
"integration": null,
"statsd_interval": null,
"per_unit": "second",
"type": "gauge",
"unit": "byte"
}メトリクスメタデータエンドポイントを使用して、メトリクスのメタデータのフィールドを編集できます。 サポートされているタイプについては、こちらを参照してください。
type [必須]:
メトリクスタイプ (gauge、rate など)description [オプション、デフォルト = None]:
メトリクスの説明の文字列short_name [必須]:
メトリクスの短縮名の文字列unit [オプション、デフォルト = None]:
メトリクスの主単位 (byte、operation など)per_unit [オプション、デフォルト = None]:
メトリクスの基準単位。たとえば、バイト/秒の場合の秒statsd_interval [オプション、デフォルト = None]:
該当する場合は、メトリクスの StatsD フラッシュ間隔 (秒単位)PUT /v1/metrics/<METRIC_NAME>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
metric = 'system.net.bytes_sent'
params = {
'description': 'My custom description',
'short_name': 'bytes sent',
'type': 'gauge',
'unit': 'byte',
'per_unit': 'second'
}
api.Metadata.update(metric_name=metric, **params)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
updates = {
"type" => "gauge",
"description" => "my custom description",
"short_name" => "bytes sent",
"unit" => "byte",
"per_unit" => "second"
}
# Submit updates for metric
result = dog.update_metadata('system.net.bytes_sent', updates)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
metric_name="system.net.bytes_sent"
curl -X PUT -H "Content-type: application/json" \
-d '{
"type": "gauge",
"description": "my custom description",
"short_name": "bytes sent",
"unit": "byte",
"per_unit": "second"
}' \
"https://api.datadoghq.com/api/v1/metrics/${metric_name}?api_key=${api_key}&application_key=${app_key}"
{
'description': 'My custom description',
'short_name': 'bytes sent',
'integration': None,
'statsd_interval': None,
'per_unit': 'second',
'type': 'gauge',
'unit': 'byte'
}
{
"description" => "My custom description",
"short_name" => "bytes sent",
"integration" => nil,
"statsd_interval" => nil,
"per_unit" => "second",
"type" => "gauge",
"unit" => "byte"
}{
"description": "my custom description",
"short_name": "bytes sent",
"integration": null,
"statsd_interval": null,
"per_unit": "second",
"type": "gauge",
"unit": "byte"
}This endpoint allows you to search for metrics from the last 24 hours in Datadog.
q [required]:
The query string. Must be prefixed with metrics:.GET /v1/search
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.Hosts.search(q="metrics:system")
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.search("metrics:system")
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -G "https://api.datadoghq.com/api/v1/search" \
-d "api_key=${api_key}" \
-d "application_key=${app_key}" \
-d "q=metrics:test"
{
'results': {
'metrics': [
'test.metric.metric',
'test.tag.metric'
]
}
}
["200", {
"results" => {
"metrics" => ["test.metric"]
}
}]
{
"results": {
"metrics": [
"test.metric"
]
}
}
Monitors allow you to watch a metric or check that you care about, notifying your team when some defined threshold is exceeded. Refer to the Creating Monitors page for more information on creating monitors.
If you manage and deploy monitors programmatically, it’s easier to define the monitor in the Datadog UI and export its valid JSON.
type [required]:
The type of the monitor, chosen from:| Monitor Type | type attribute value |
|---|---|
| anomaly | query alert |
| apm | query alert |
| composite | composite |
| custom | service check |
| event | event alert |
| forecast | query alert |
| host | service check |
| integration | query alert or service check |
| live process | process alert |
| logs | log alert |
| metric | metric alert |
| network | service check |
| outlier | query alert |
| process | service check |
| watchdog | event alert |
query [required]:
The query defines when the monitor triggers. Query syntax depends on what type of monitor you are creating:
time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #
time_aggr: avg, sum, max, min, change, or pct_changetime_window: last_#m (with # being 5, 10, 15, or 30) or last_#h(with # being 1, 2, or 4), or last_1dspace_aggr: avg, sum, min, or maxtags: one or more tags (comma-separated), or *key: a ‘key’ in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert)operator: <, <=, >, >=, ==, or !=#: an integer or decimal number used to set the thresholdIf you are using the _change_ or _pct_change_ time aggregator, instead use change_aggr(time_aggr(time_window), timeshift):space_aggr:metric{tags} [by {key}] operator # with:
change_aggr change, pct_changetime_aggr avg, sum, max, min Learn moretime_window last#m (1, 5, 10, 15, or 30), last#h (1, 2, or 4), or last_#d (1 or 2)timeshift #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_agoUse this to create an outlier monitor using the following query: avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0
"check".over(tags).last(count).count_by_status()
check name of the check, e.g. datadog.agent.uptags one or more quoted tags (comma-separated), or “*“. e.g.: .over("env:prod", "role:db")count must be at >= your max threshold (defined in the options). e.g. if you want to notify on 1 critical, 3 ok and 2 warn statuses count should be 3. It is limited to 10.events('sources:nagios status:error,warning priority:normal tags: "string query"').rollup("count").last("1h")"
event, the event query string:string_query free text query to match against event title and text.sources event sources (comma-separated). Complete list of source attribute valuesstatus event statuses (comma-separated). Valid options: error, warn, and info.priority event priorities (comma-separated). Valid options: low, normal, all.host event reporting host (comma-separated).tags event tags (comma-separated).excluded_tags exluded event tags (comma-separated).rollup the stats rollup method. count is the only supported method now.last the timeframe to roll up the counts. Examples: 60s, 4h. Supported timeframes: s, m, h and d.processes(search).over(tags).rollup('count').last(timeframe) operator #
search free text search string for querying processes. Matching processes match results on the Live Processes pagetags one or more tags (comma-separated)timeframe the timeframe to roll up the counts. Examples: 60s, 4h. Supported timeframes: s, m, h and doperator <, <=, >, >=, ==, or !=# an integer or decimal number used to set the threshold12345 && 67890, where 12345 and 67890 are the IDs of non-composite monitors
name [required, default = dynamic, based on query]:
The name of the alert.
message [required, default = dynamic, based on query]:
A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same ‘@username’ notation as events.
tags [optional, default = empty list]:
A list of tags to associate with your monitor. When getting all monitor details via the API, use the monitor_tags argument to filter results by these tags. It is only available via the API and isn’t visible or editable in the Datadog UI.
options [optional, default={}]:
A dictionary of options for the monitor. There are options that are common to all types as well as options that are specific to certain monitor types.
silenced dictionary of scopes to timestamps or None. Each scope is muted until the given POSIX timestamp or forever if the value is None. Default: None
Examples:
{'*': None}role:db for a short time: {'role:db': 1412798116}new_host_delay Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Default: 300
notify_no_data a Boolean indicating whether this monitor notifies when data stops reporting. Default: false
no_data_timeframe the number of minutes before a monitor notifies when data stops reporting. This parameter is mandatory when notify_no_data is set to true. It must be at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks. Default: 2x timeframe for metric alerts, 2 minutes for service checks
timeout_h the number of hours of the monitor not reporting data before it automatically resolves from a triggered state. Default: None.
require_full_window a Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to False for sparse metrics, otherwise some evaluations are skipped. Default: True for “on average”, “at all times” and “in total” aggregation. False otherwise.
renotify_interval the number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved. Default: None.
escalation_message a message to include with a re-notification. Supports the ‘@username’ notification we allow elsewhere. Not applicable if renotify_interval is None. Default: None.
notify_audit a Boolean indicating whether tagged users is notified on changes to this monitor. Default: False
locked a Boolean indicating whether changes to to this monitor should be restricted to the creator or admins. Default: False
include_tags a Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. Default: True Examples:
[Triggered on {host:h1}] Monitor Title[Triggered] Monitor TitleThese options only apply to anomaly monitors and are ignored for other monitor types.
threshold_windows a dictionary containing recovery_window and trigger_window.
recovery_window describes how long an anomalous metric must be normal before the alert recoverstrigger_window describes how long a metric must be anomalous before an alert triggers
Example: {'threshold_windows': {'recovery_window': 'last_15m', 'trigger_window': 'last_15m'}}
These options only apply to metric alerts.
thresholds a dictionary of thresholds by threshold type. There are two threshold types for metric alerts: critical and warning. Critical is defined in the query, but can also be specified in this option. Warning threshold can only be specified using the thresholds option.
If you want to use recovery thresholds for your monitor, use the attributes critical_recovery and warning_recovery.
Example: `{'critical': 90, 'warning': 80, 'critical_recovery': 70, 'warning_recovery': 50}`
evaluation_delay Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation.
These options only apply to service checks and are ignored for other monitor types.
thresholds a dictionary of thresholds by status. Because service checks can have multiple thresholds, we don’t define them directly in the query.
Example: `{'ok': 1, 'critical': 1, 'warning': 1}`
If an invalid monitor option is included in the request, the response will be:
Error: 400 - ["Invalid monitor option:<invalid option>"]
POST /v1/monitor
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Create a new monitor
monitor_options = {
"notify_no_data": True,
"no_data_timeframe": 20
}
tags = ["app:webserver", "frontend"]
api.Monitor.create(
type="metric alert",
query="avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
name="Bytes received on host0",
message="We may need to add web hosts if this is consistently high.",
tags=tags,
options=monitor_options
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Create a new monitor
options = {
'notify_no_data' => true,
'no_data_timeframe' => 20
}
tags = ['app:webserver', 'frontend']
dog.monitor("metric alert", "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", :name => "Bytes received on host0", :message => "We may need to add web hosts if this is consistently high.", :tags => tags, :options => options)#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"type": "metric alert",
"query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
"name": "Bytes received on host0",
"message": "We may need to add web hosts if this is consistently high.",
"tags": ["app:webserver", "frontend"],
"options": {
"notify_no_data": true,
"no_data_timeframe": 20
}
}' \
"https://api.datadoghq.com/api/v1/monitor?api_key=${api_key}&application_key=${app_key}"{'creator': {'email': 'matt@example.com',
'handle': 'matt@example.com',
'id': 1896,
'name': u'Matt'},
'id': 2081,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'tags': ['app:webserver', 'frontend'],
'options': {'no_data_timeframe': 20,
'notify_audit': False,
'notify_no_data': True,
'silenced': {}},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'multi': False,
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T16:34:14.014039+00:00'
}
["200", {
"name" => "Bytes received on host0",
"org_id" => 1499,
"tags" => ["app:webserver", "frontend"],
"options" => {
"notify_no_data" => true,
"no_data_timeframe" => 20,
"notify_audit" => false,
"silenced" => {}
},
"state" => {},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"message" => "We may need to add web hosts if this is consistently high.",
"type" => "metric alert",
"id" => 92089,
"multi" => false,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T16:34:14.014039+00:00"
}]{
"id": 92090,
"message": "We may need to add web hosts if this is consistently high.",
"name": "Bytes received on host0",
"tags": ["app:webserver", "frontend"],
"options": {
"no_data_timeframe": 20,
"notify_audit": false,
"notify_no_data": true,
"silenced": {}
},
"org_id": 1499,
"query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
"state": {},
"type": "metric alert",
"multi": false,
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T16:34:14.014039+00:00"
}
group_states [オプション、デフォルト = None]:
この引数を設定すると、指定したグループ状態に関する追加情報があれば、それを含むデータが返されます。たとえば、最後の通知タイムスタンプ、最後の解決タイムスタンプ、モニターがトリガーした最後の時間などです。この引数は、どのグループ状態を追加するかを含む文字列リストを指定します。all、alert、warn、no data から 1 つ以上を選択します。例: ‘alert,warn’”GET /v1/monitor/<MONITOR_ID>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Get a monitor's details
api.Monitor.get(2081, group_states='all')
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get a monitors's details
dog.get_monitor(91879, :group_states => 'all')#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
monitor_id=<YOUR_MONITOR_ID>
# Show a monitor
curl -G "https://api.datadoghq.com/api/v1/monitor/${monitor_id}" \
-d "api_key=${api_key}" \
-d "application_key=${app_key}" \
-d "group_states=all"
{
'id': 2081,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'options': {
'no_data_timeframe': 20,
'notify_audit': False,
'notify_no_data': True,
'silenced': {}
},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'multi': False,
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T16:34:14.014039+00:00',
"state": {
"groups": {
"host:host0": {
"last_nodata_ts": null,
"last_notified_ts": 1481909160,
"last_resolved_ts": 1481908200,
"last_triggered_ts": 1481909160,
"name": "host:host0",
"status": "Alert",
"triggering_value": {
"from_ts": 1481909037,
"to_ts": 1481909097,
"value": 1000
}
}
}
}
}
["200", {
"name" => "Bytes received on host0",
"org_id" => 1499,
"options" => {
"no_data_timeframe" => 20,
"notify_no_data" => false,
"notify_audit" => false,
"silenced" => {}
},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"message" => "We may need to add web hosts if this is consistently high.",
"type" => "metric alert",
"id" => 91879,
"multi" => false,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T16:34:14.014039+00:00",
"state" => {
"groups" => {
"host:host0" => {
"last_nodata_ts" => null,
"last_notified_ts" => 1481909160,
"last_resolved_ts" => 1481908200,
"last_triggered_ts" => 1481909160,
"name" => "host:host0",
"status" => "Alert",
"triggering_value" => {
"from_ts" => 1481909037,
"to_ts" => 1481909097,
"value" => 1000
}
}
}
}
}]
{
"id": 91879,
"message": "We may need to add web hosts if this is consistently high.",
"name": "Bytes received on host0",
"options": {
"no_data_timeframe": 20,
"notify_audit": false,
"notify_no_data": false,
"silenced": {}
},
"org_id": 1499,
"query": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"type": "metric alert",
"multi": false,
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T16:34:14.014039+00:00",
"state": {
"groups": {
"host:host0": {
"last_nodata_ts": null,
"last_notified_ts": 1481909160,
"last_resolved_ts": 1481908200,
"last_triggered_ts": 1481909160,
"name": "host:host0",
"status": "Alert",
"triggering_value": {
"from_ts": 1481909037,
"to_ts": 1481909097,
"value": 1000
}
}
}
}
}
query [必須]:
アラートするメトリクスクエリ。name [必須]:
モニターの名前。message [オプション、デフォルト = dynamic。クエリに基づく]:
このモニターの通知に含めるメッセージ。イベントと同じ「@username」表記を使用して、特定のユーザーに電子メール通知を送信できます。options [オプション、デフォルト = {}]:
使用可能なオプションについては、モニターの作成に関するドキュメントを参照してください。tags [オプション、デフォルト = None]:
モニターに関連付けられるタグのリスト。モニターの分類と絞り込みに役立ちます。PUT /v1/monitor/<MONITOR_ID>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Edit an existing monitor
api.Monitor.update(
2081,
query="avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
name="Bytes received on host0",
message="We may need to add web hosts if this is consistently high."
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Edit an existing monitor
dog.update_monitor(91879, "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", :message => "Bytes received on host0", :name => "We may need to add web hosts if this is consistently high.")#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
monitor_id=<YOUR_MONITOR_ID>
# Edit a monitor
curl -X PUT -H "Content-type: application/json" \
-d '{
"query": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"name": "Bytes received on host0",
"message": "We may need to add web hosts if this is consistently high."
}' \
"https://api.datadoghq.com/api/v1/monitor/${monitor_id}?api_key=${api_key}&application_key=${app_key}"
{
'id': 2081,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'options': {'notify_audit': False, 'notify_no_data': False, 'silenced': {}},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'multi': False,
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T18:39:24.391207+00:00'
}
[
"200", {
"name" => "We may need to add web hosts if this is consistently high.",
"org_id" => 1499,
"options" => {
"notify_no_data" => false, "notify_audit" => false, "silenced" => {}
},
"state" => {},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"message" => "Bytes received on host0",
"type" => "metric alert",
"id" => 91879,
"multi" => false,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T18:39:24.391207+00:00"
}
]{ "id": 91879,
"message": "We may need to add web hosts if this is consistently high.",
"name": "Bytes received on host0",
"options": {
"notify_audit": false,
"notify_no_data": false,
"silenced": {}
},
"org_id": 1499,
"query": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"state": {},
"type": "metric alert",
"multi": false,
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T18:39:24.391207+00:00"}このエンドポイントは、JSON 引数を受け取りません。
DELETE /v1/monitor/<MONITOR_ID>
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Delete a monitor
api.Monitor.delete(2081)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Delete a monitor
dog.delete_monitor(62625)#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
monitor_id=<YOUR_MONITOR_ID>
# Delete a monitor
curl -X DELETE "https://api.datadoghq.com/api/v1/monitor/${monitor_id}?api_key=${api_key}&application_key=${app_key}"
{
'deleted_monitor_id': 2081
}
["200", {
"deleted_monitor_id" => 62625
}]{
"deleted_monitor_id": 59409
}group_states [optional, default=None]:
If this argument is set, the returned data includes additional information (if available) regarding the specified group states, including the last notification timestamp, last resolution timestamp and details about the last time the monitor was triggered. The argument should include a string list indicating what, if any, group states to include. Choose one or more from ‘all’, ‘alert’, ‘warn’, or ‘no data’. Example: ‘alert,warn’name [optional, default=None]:
A string to filter monitors by nametags [optional, default=None]:
A comma separated list indicating what tags, if any, should be used to filter the list of monitorsby scope, e.g. host:host0. For more information, see the tags parameter for the appropriate query argument in the Create a monitor section above.monitor_tags [optional, default=None]:
A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. Tags created in the Datadog UI automatically have the service key prepended (e.g. service:my-app)with_downtimes [optional, default = true]:
If this argument is set to true, then the returned data includes all current downtimes for each monitor.page [optional, default = 0]:
The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination.page_size [optional, default=100]:
The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a page_size limit. However, if page is specified and page_size is not, the argument defaults to 100.GET /v1/monitor
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Get all monitor details
print api.Monitor.get_all()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get all monitor details
dog.get_all_monitors()#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -G "https://api.datadoghq.com/api/v1/monitor" \
-d "api_key=${api_key}" \
-d "application_key=${app_key}"
[
{'creator': {
'email': 'matt@example.com',
'handle': 'matt@example.com',
'id': 1896,
'name': u'Matt'
},
'id': 2085,
'message': u'',
'name': '**system.net.bytes_rcvd** over **host:host0** was **> 100** on average during the **last 1h**.',
'options': {'notify_audit': False, 'notify_no_data': False, 'silenced': {}},
'org_id': 2,
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'multi': False,
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T18:39:24.391207+00:00'},
{'creator': {'email': 'matt@example.com',
'handle': 'matt@example.com',
'id': 1896,
'name': u'Matt'},
'id': 2083,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'options': {'no_data_timeframe': 20,
'notify_audit': False,
'notify_no_data': True,
'silenced': {}},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'multi': False,
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T18:39:24.391207+00:00'
}
]
[
"200", [{
"name" => "Bytes received on host0",
"org_id" => 1499,
"options" => {
"notify_no_data" => false, "notify_audit" => false, "silenced" => {}
},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"message" => "We may need to add web hosts if this is consistently high.",
"type" => "metric alert",
"multi" => false,
"id" => 91879,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T16:34:14.014039+00:00"
}, {
"name" =>
"**system.net.bytes_rcvd** over **host:host0** was **> 100** on average during the **last 1h**.",
"org_id" => 1499,
"options" => {
"notify_audit" => true,
"timeout_h" => nil,
"silenced" => {},
"no_data_timeframe" => false,
"notify_no_data" => false,
"renotify_interval" => nil,
"escalation_message" => ""
},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"message" => "",
"type" => "metric alert",
"multi" => false,
"id" => 91875,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T16:34:14.014039+00:00"
}]
][
{
"tags":[
],
"deleted":null,
"query":"change(avg(last_5m),last_1m):avg:apache.net.hits{*} by {host} > 500",
"message":"Host {{host.name}} with IP {{host.ip}} is under heavy load.",
"matching_downtimes":[
],
"id":1111111,
"multi":true,
"name":"example title",
"created":"2019-03-11T17:20:45.414125+00:00",
"created_at":1552324845000,
"creator":{
"id":1111111,
"handle":"example@example.com",
"name":"Jane Doe",
"email":"example@example.com"
},
"org_id":1111111,
"modified":"2019-03-11T17:20:45.414125+00:00",
"overall_state_modified":"2019-03-19T12:55:48.320241+00:00",
"overall_state":"No Data",
"type":"query alert",
"options":{
"notify_audit":false,
"locked":false,
"timeout_h":0,
"silenced":{
},
"include_tags":true,
"no_data_timeframe":null,
"require_full_window":true,
"new_host_delay":300,
"notify_no_data":false,
"renotify_interval":0,
"escalation_message":"",
"thresholds":{
"critical":500,
"warning":250
}
}
},
{
"tags":[
],
"deleted":null,
"query":"avg(last_1m):outliers(avg:apache.net.hits{*} by {host}, 'DBSCAN', 3) > 0",
"message":"@example@example.com",
"matching_downtimes":[
],
"id":1111111,
"multi":true,
"name":"example title",
"created":"2019-03-11T18:10:09.957865+00:00",
"created_at":1552327809000,
"creator":{
"id":111111,
"handle":"example@example.com",
"name":"Jane Doe",
"email":"example@example.com"
},
"org_id":1111111,
"modified":"2019-03-11T18:11:25.217705+00:00",
"overall_state_modified":"2019-03-20T12:50:45.684420+00:00",
"overall_state":"No Data",
"type":"query alert",
"options":{
"notify_audit":false,
"locked":false,
"timeout_h":0,
"silenced":{
},
"include_tags":true,
"no_data_timeframe":null,
"require_full_window":true,
"new_host_delay":300,
"notify_no_data":false,
"renotify_interval":0,
"escalation_message":""
}
}
]resolve [必須]:
特定の monitor_id に対して解決するグループの配列。例:
{"monitor_id": "group_to_resolve"}
1 つのモニターで複数のグループがサポートされます。例:
resolve: [{"monitor_id": "group_1"}, {"monitor_id": "group_2"}]
擬似グループ ALL_GROUPS を使用して、トリガーされたすべてのグループを解決することもできます。
resolve: [{"monitor_id": "ALL_GROUPS"}]
POST https://api.datadoghq.com/monitor/bulk_resolve
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"resolve": [
{"<YOUR_MONITOR_ID>": "<YOUR_FIRST_GROUP>"},
{"<YOUR_MONITOR_ID>": "<YOUR_SECOND_GROUP>"}
]
}' \
"https://app.datadoghq.com/monitor/bulk_resolve?api_key=${api_key}&application_key=${app_key}"# This is not yet supported by the Python Client for Datadog API
# Consult the curl example# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
[
{
"tags": [
"*"
],
"deleted": null,
"query": "avg(last_1h):avg:system.cpu.user{role:cassandra} by {host} > 10",
"message": "I'm a dummy test.",
"id": 2610751,
"multi": true,
"name": "[Do not mind] This is a test",
"created": "2017-08-09T14:30:38.584147+00:00",
"created_at": 1502289038000,
"org_id": 11287,
"modified": "2017-08-09T14:36:48.176919+00:00",
"overall_state_modified": "2017-08-11T12:21:05.949182+00:00",
"overall_state": "Alert",
"type": "metric alert",
"options": {
"notify_audit": false,
"locked": false,
"timeout_h": 0,
"silenced": {},
"include_tags": false,
"no_data_timeframe": 10,
"new_host_delay": 300,
"require_full_window": false,
"notify_no_data": false,
"renotify_interval": 0,
"escalation_message": "",
"thresholds": {
"critical": 10,
"warning": 5
}
}
}
]Muting prevents all monitors from notifying through email and posts to the event stream. State changes are only visible by checking the alert page.
This endpoint takes no JSON arguments.
POST /v1/monitor/mute_all
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Mute all monitors
api.Monitor.mute_all()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Mute all alerts
dog.mute_monitors()#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" "https://api.datadoghq.com/api/v1/monitor/mute_all?api_key=${api_key}&application_key=${app_key}"
{
'active': True,
'disabled': False,
'end': None,
'id': 2728,
'message': None,
'scope': ['*'],
'start': 1419440110
}
[
"200", {
"end" => nil,
"disabled" => false,
"start" => 1412805855,
"active" => true,
"scope" => ["*"],
"id" => 1647
}
]{
"active": true,
"disabled": false,
"end": null,
"id": 1648,
"scope": [
"*"
],
"start": 1412805856
}Disables muting all monitors. Throws an error if mute all was not enabled previously.
This endpoint takes no JSON arguments.
POST /v1/monitor/unmute_all
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Unmute all alerts
api.Monitor.unmute_all()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Unmute all alerts
dog.unmute_monitors()#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" "https://api.datadoghq.com/api/v1/monitor/unmute_all?api_key=${api_key}&application_key=${app_key}"
This endpoint does not return JSON on successful requests.
scope [オプション、デフォルト = None]:
ミュートする対象のスコープ。例: role:db。
たとえば、アラートが {host} でグループ化されている場合は、host:app1 をミュートできます。end [オプション、デフォルト = None]:
ミュートの終了時間を示す POSIX タイムスタンプ。POST /v1/monitor/<MONITOR_ID>/mute
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Mute a monitor
api.Monitor.mute(2088)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Mute a monitor
dog.mute_monitor(62628)#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
monitor_id=<YOUR_MONITOR_ID>
# Mute a monitor
curl -X POST -H "Content-type: application/json" "https://api.datadoghq.com/api/v1/monitor/${monitor_id}/mute?api_key=${api_key}&application_key=${app_key}"
{
'id': 2088,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'options': {
'notify_audit': False,
'notify_no_data': False,
'silenced': {
'*': None
}
},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T18:39:24.391207+00:00'
}
[
"200", {
"name" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"org_id" => 1499,
"options" => {
"notify_no_data" => false,
"notify_audit" => true,
"timeout_h" => nil,
"silenced" => {
"*" => nil
},
"is_data_sparse" => false,
"renotify_interval" => nil
},
"state" => {},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"message" => "",
"type" => "metric alert",
"id" => 62628,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T18:39:24.391207+00:00"
}
]{
"id": 62628,
"message": "",
"name": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"options": {
"is_data_sparse": false,
"notify_audit": true,
"notify_no_data": false,
"renotify_interval": null,
"silenced": {
"*": null
},
"timeout_h": null
},
"org_id": 1499,
"query": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"state": {},
"type": "metric alert",
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T18:39:24.391207+00:00"
}
scope [オプション、デフォルト = None]:
ミュートする対象のスコープ。
たとえば、アラートが {host} でグループ化されている場合は、’host:app1’ をミュートできます。all_scopes [オプション、デフォルト = False]:
すべてのスコープのミュートをクリアします。POST /v1/monitor/<MONITOR_ID>/unmute
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Unmute all alerts
api.Monitor.unmute(2088)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Unmute all alerts
dog.unmute_monitor(62628)#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
monitor_id=<YOUR_MONITOR_ID>
# Unmute a monitor
curl -X POST "https://api.datadoghq.com/api/v1/monitor/${monitor_id}/unmute?api_key=${api_key}&application_key=${app_key}"
{
'id': 2088,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'options': {
'notify_audit': False,
'notify_no_data': False,
'silenced': {}
},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T18:39:24.391207+00:00'
}
[
"200", {
"name" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"org_id" => 1499,
"options" => {
"notify_no_data" => false,
"notify_audit" => true,
"timeout_h" => nil,
"silenced" => {},
"is_data_sparse" => false,
"renotify_interval" => nil
},
"state" => {},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"message" => "",
"type" => "metric alert",
"id" => 62628,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T18:39:24.391207+00:00"
}
]{
"id": 62628,
"message": "",
"name": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"options": {
"is_data_sparse": false,
"notify_audit": true,
"notify_no_data": false,
"renotify_interval": null,
"silenced": {
"*": null
},
"timeout_h": null
},
"org_id": 1499,
"query": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"state": {},
"type": "metric alert",
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T18:39:24.391207+00:00"
}このエンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
モニター定義を検証します。モニター定義の構成の詳細については、モニターの作成を参照してください。
POST /v1/monitor/validate
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"type": "metric alert",
"query": "THIS QUERY IS INVALID",
"name": "Bytes received on host0",
"message": "We may need to add web hosts if this is consistently high.",
"tags": ["app:webserver", "frontend"],
"options": {
"notify_no_data": true,
"no_data_timeframe": 20
}
}' \
"https://api.datadoghq.com/api/v1/monitor/validate?api_key=${api_key}&application_key=${app_key}"
{}["200", {}]{
"errors": [
"The value provided for parameter 'query' is invalid"
]
}
Search and filter your monitors details.
query [optional]:
After entering a search query in your Manage Monitor page use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated manage monitor documentation page to learn more.
The query can contain any number of space-separated monitor attributes, for instance query="type:metric status:alert".
page [optional, default = 0]:
Page to start paginating from.
per_page [optional, default=30]:
Number of monitors to return per page.
sort [optional, default=null]:
Comma separated string for sort order (e.g. name,asc) supported fields:
namestatustagsGET /v1/monitor/search
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Search monitors
api.Monitor.search()
# Examples of possible query parameters:
# api.Monitor.search(query="id:7100311")
# api.Monitor.search(query="title:foo metric:system.core.idle status:Alert")
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Search monitors
dog.search_monitors()
# Examples of possible query parameters:
# dog.search_monitors(query="id:7100311")
# dog.search_monitors(query="title:foo metric:system.core.idle status:Alert")
#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
query=<MANAGE_MONITOR_QUERY>
page=<PAGE_NUMBER>
per_page=<PER_PAGE>
sort=<SORT>
curl -X GET \
"https://api.datadoghq.com/api/v1/monitor/search?api_key=${api_key}&application_key=${app_key}&query=${query}&page=${page}&per_page=${per_page}&sort=${sort}"
{ u'counts':
{ u'muted': [{ u'count': 1, u'name': False}],
u'status': [{ u'count': 1, u'name': u'Alert'}],
u'tag': [ { u'count': 1, u'name': u'env:myenv'},
{ u'count': 1, u'name': u'service:sample'}],
u'type': [{ u'count': 1, u'name': u'apm'}]},
u'metadata': { u'page': 0,
u'page_count': 1,
u'per_page': 30,
u'total_count': 1},
u'monitors':
[ { u'classification': u'apm',
u'creator': { u'handle': u'jane@example.com',
u'id': 795042,
u'name': u'Jane'},
u'id': 6797333,
u'last_triggered_ts': 1540483133,
u'metrics': [ u'trace.servlet.request.hits',
u'trace.servlet.request.errors'],
u'name': u'Service sample has a high error rate on env:myenv',
u'notifications': [ { u'handle': u'jane@example.com',
u'name': u'Jane'}],
u'org_id': 11287,
u'scopes': [u'env:myenv', u'service:sample'],
u'status': u'Alert',
u'tags': [u'env:myenv', u'service:sample'],
u'type': u'query alert'}]}
["200",
{"counts"=>
{"status"=>[{"count"=>1, "name"=>"Alert"}],
"muted"=>[{"count"=>1, "name"=>false}],
"tag"=>
[{"count"=>1, "name"=>"env:myenv"},
{"count"=>1, "name"=>"service:sample"}],
"type"=>[{"count"=>1, "name"=>"apm"}]},
"monitors"=>
[{"status"=>"Alert",
"scopes"=>["env:myenv", "service:sample"],
"classification"=>"apm",
"creator"=>
{"handle"=>"jane@example.com",
"id"=>795042,
"name"=>"Jane"},
"metrics"=>["trace.servlet.request.hits", "trace.servlet.request.errors"],
"notifications"=>
[{"handle"=>"jane@example.com", "name"=>"Jane"}],
"last_triggered_ts"=>1540483133,
"id"=>6797333,
"name"=>"Service sample has a high error rate on env:myenv",
"tags"=>["env:myenv", "service:sample"],
"org_id"=>11287,
"type"=>"query alert"}],
"metadata"=>{"total_count"=>1, "page_count"=>1, "page"=>0, "per_page"=>30}}]
{
"counts": {
"status": [
{
"count": 4,
"name": "No Data"
},
{
"count": 2,
"name": "OK"
}
],
"muted": [
{
"count": 3,
"name": false
},
{
"count": 3,
"name": true
}
],
"tag": [
{
"count": 6,
"name": "service:cassandra"
}
],
"type": [
{
"count": 6,
"name": "metric"
}
]
},
"monitors": [
{
"status": "No Data",
"scopes": [
"!availability-zone:us-east-1c",
"name:cassandra"
],
"classification": "metric",
"creator": {
"handle": "xxxx@datadoghq.com",
"name": "xxxx@datadoghq.com",
"id": {
"handle": "xxxx@datadoghq.com",
"id": 1234,
"name": null
}
},
"metrics": [
"system.cpu.user"
],
"notifications": [
{
"handle": "xxxx@datadoghq.com",
"name": "xxxx@datadoghq.com"
}
],
"last_triggered_ts": null,
"id": 2699850,
"name": "Cassandra CPU is high on {{host.name}} in {{availability-zone.name}}",
"tags": [
"service:cassandra"
],
"org_id": 1234,
"type": "metric alert"
},
{
"status": "OK",
(...)
},
],
"metadata": {
"total_count": 6,
"page_count": 6,
"page": 0,
"per_page": 30
}
}Search and filter your monitor groups details.
query [optional]:
After entering a search query in your Manage Monitor page use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated manage monitor documentation page to learn more.
page [optional, default = 0]:
Page to start paginating from.
per_page [optional, default=30]:
Number of monitors to return per page.
sort [optional, default=null]:
Comma separated string for sort order (e.g. name,asc) supported fields:
namestatustagsGET /v1/monitor/groups/search
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Search monitor groups
api.Monitor.search_groups()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Search monitor groups
dog.search_monitor_groups()
#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
query=<MANAGE_MONITOR_QUERY>
page=<PAGE_NUMBER>
per_page=<PER_PAGE>
sort=<SORT>
curl -X GET \
"https://api.datadoghq.com/api/v1/monitor/groups/search?api_key=${api_key}&application_key=${app_key}&query=${query}&page=${page}&per_page=${per_page}&sort=${sort}"
{ u'counts':
{ u'status': [{ u'count': 1, u'name': u'Alert'}],
u'type': [{ u'count': 1, u'name': u'apm'}]},
u'groups': [ { u'group': u'*',
u'group_tags': [u'*'],
u'last_nodata_ts': 0,
u'last_triggered_ts': 1540483133,
u'monitor_id': 6797333,
u'monitor_name': u'Service sample has a high error rate on env:myenv',
u'status': u'Alert'}],
u'metadata': { u'page': 0,
u'page_count': 1,
u'per_page': 30,
u'total_count': 1}}
["200",
{"counts"=>
{"status"=>[{"count"=>1, "name"=>"Alert"}],
"type"=>[{"count"=>1, "name"=>"apm"}]},
"groups"=>
[{"status"=>"Alert",
"last_triggered_ts"=>1540483133,
"group"=>"*",
"monitor_id"=>6797333,
"group_tags"=>["*"],
"last_nodata_ts"=>0,
"monitor_name"=>"Service sample has a high error rate on env:myenv"}],
"metadata"=>{"total_count"=>1, "page_count"=>1, "page"=>0, "per_page"=>30}}]
{
"counts": {
"status": [
{
"count": 2,
"name": "OK"
}
],
"type": [
{
"count": 2,
"name": "metric"
}
]
},
"groups": [
{
"status": "OK",
"last_triggered_ts": 1525702966,
"group": "*",
"monitor_id": 2738266,
"group_tags": [
"*"
],
"last_nodata_ts": 0,
"monitor_name": "[demo] Cassandra disk usage is high on {{host.name}}"
},
{
"status": "OK",
"last_triggered_ts": 1525703008,
"group": "*",
"monitor_id": 1576648,
"group_tags": [
"*"
],
"last_nodata_ts": 0,
"monitor_name": "[demo] Disk usage is high on {{host.name}}"
}
],
"metadata": {
"total_count": 2,
"page_count": 2,
"page": 0,
"per_page": 30
}
}The Organization endpoints are not supported in Datadog’s client libraries. To request this functionality, contact Datadog Support.
You can create, edit, and manage organizations. Read more about multi-org accounts.
This endpoint requires the multi-org account feature and must be enabled by contacting support.
name [required]:
The name of the new child-organization, limited to 32 characters.subscription [required]:
A JSON array of subscription type. Types available are trial, free, and pro.billing [required]:
A JSON array of billing type. Note that only parent_billing is supported.Once a new child-organization is created, you can interact with it by using the org.public_id, api_key.key, and application_key.hash provided in the response.
POST /v1/org
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"name" :"My Org",
"subscription" :{"type":"pro"},
"billing" :{"type":"parent_billing"}
}' \
"https://api.datadoghq.com/api/v1/org?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"org" : {
"name" : "My Org",
"public_id" : "axd2s",
"subscription" : {
"type" : "pro"
},
"billing" : {
"type" : "parent_billing"
}
},
"user" : {
"name" : "Organization admin",
"handle" : "test@datadoghq.com",
...
},
"api_key" : {
"created_by": "user",
"key": "6ccdfb88ff1aa63192c326"
...
},
"application_key": {
"owner": "Organization admin",
"hash": "88e5ae6a71f51d1d5a0071a24f",
...
}
}
GET /v1/org
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X GET "https://api.datadoghq.com/api/v1/org?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"orgs" : [{
"name" : "My Org",
"public_id" : "axd2s",
"subscription" : {
"type" : "pro"
},
"billing" : {
"type" : "bill-parent"
}
}]
}
name [オプション]:
オーガニゼーション名。settings [オプション]:
設定の JSON 配列。設定は次のとおりです。saml - ブール値プロパティ enabled を設定して、SAML を使用したシングルサインオンを有効または無効にします。すべての SAML 設定の詳細については、SAML に関するドキュメントを参照してください。saml_idp_initiated_login enabled というブール値プロパティがあります。saml_strict_mode enabled というブール値プロパティがあります。saml_autocreate_users_domains enabled (ブール値) と domains (@ 記号なしのドメインのリスト) という 2 つのプロパティがあります。PUT /v1/org/<PUBLIC_ID>
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
public_id=axd2s
curl -X PUT -H "Content-type: application/json" \
-d '{
"settings": {
"saml": {
"enabled": true
},
"saml_strict_mode": {
"enabled": true
},
"saml_idp_initiated_login": {
"enabled": true
},
"saml_autocreate_users_domains": {
"enabled": true,
"domains": [
"my-org.com",
"example.com"
]
}
}
}' \
"https://api.datadoghq.com/api/v1/org/${public_id}?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"org": {
"public_id": "axd2s",
"name": "My Org",
"billing": {},
"created": "2016-10-06 21:41:12",
"settings": {
"saml_can_be_enabled": true,
"saml_idp_initiated_login": {
"enabled": true
},
"saml": {
"enabled": true
},
"saml_idp_endpoint": "https://idp.datadoghq.com/idp/profile/SAML2/POST/SSO",
"saml_autocreate_users_domains": {
"domains": [
"my-org.com",
"example.com"
],
"enabled": true
},
"saml_login_url": "https://app.datadoghq.com/account/login/id/c81e728d9",
"saml_idp_metadata_uploaded": true,
"saml_strict_mode": {
"enabled": true
}
},
"subscription": {
"type": "pro"
}
}
}
現在の SAML IdP から Identity Provider (IdP) メタデータを更新するためのオプションがいくつかあります。
Content-Type: multipart/form-dataidp_file [必須]:
アップロードする XML メタデータファイルのパス。Content-Type: application/xml本文には IdP メタデータ XML ファイルの内容が含まれている必要があります。
POST /v1/org/<PUBLIC_ID>/idp_metadata
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
public_id=<DD_APP_PUBLIC_ID>
# Upload IdP file using multipart/form-data
curl -X POST -H "Content-Type: multipart/form-data" \
-F "idp_file=@metadata.xml" \
"https://api.datadoghq.com/api/v1/org/${public_id}/idp_metadata?api_key=${api_key}&application_key=${app_key}"
# OR
# Upload IdP file using application/xml
curl -X POST -H "Content-Type: application/xml" \
--data-binary "@metadata.xml" \
"https://api.datadoghq.com/api/v1/org/${public_id}/idp_metadata?api_key=${api_key}&application_key=${app_key}"
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"message": "IdP metadata successfully uploaded for org Datadog HQ"
}
The Synthetics endpoints are not supported in Datadog’s client libraries. To request this functionality, contact Datadog Support.
Datadog Synthetics uses simulated user requests and browser rendering to help you ensure uptime, identify regional issues, and track your application performance.
You can use Datadog’s API to create Synthetics API tests programmatically. API tests are HTTP requests (GET, POST, PUT, PATCH, DELETE) executed by Datadog to your web properties or application endpoints at configurable periodic intervals from multiple locations around the world. These checks verify that your applications are responding to requests, as well as that they meet any conditions you define—such as response time, HTTP status code, and header or body contents.
For more information about Synthetics, see the Synthetics overview.
Datadog からお客様の API エンドポイントまたはブラウザアプリに送信するテストを始動および構成するための Synthetics テストを作成します。テスト対象のエンドポイント、テストの回数、およびテストの送信元を構成することができます。必要なパラメーターは API テストとブラウザテストで異なり、それに応じてマークされています。required とマークされたパラメーターは、両方のテストに必要です。作成したテストは、UI の Synthetics リストに表示されます。
ブラウザテストは GET API テストと同様に処理されます。この方法でブラウザテストを作成できますが、テストを記録するには UI を使用する必要があります。
assertions - 必須 - テストに合格したと見なせる状態を正確に定義する場所です。各アサーションは、type、operator、target のほかに、1 つの property を持つことがあります。type - API テストで必須 - 評価する応答の部分。有効なタイプは、header、body、responseTime、および statusCode です。ヘッダーを定義する際は、property パラメーターでヘッダーパラメーターキーを指定し、target パラメーターでヘッダーパラメーター値を指定する必要があります。他のタイプでは、target を使用して本文、応答時間、およびエラーメッセージを指定します。たとえば、"type":"statusCode" に対して "target":403 になります。operator - API テストで必須 - ターゲットと、応答からの実際の値を比較する方法を定義します。有効な演算子はアサーションの type に依存します。以下に、タイプ別の有効な演算子をリストします。type | 有効な operator | 値の型 |
|---|---|---|
| statusCode | is、is not | 整数 |
| responseTime | lessThan | 整数 |
| headers | contains、does not contain、is、is not、matches、does not match | contains/does not contain/is/is not の場合は文字列、matches/does not match の場合は RegexString |
| body | contains、does not contain、is、is not、matches、does not match | contains/does not contain/is/is not の場合は文字列、matches/does not match の場合は RegexString |
target - API テストで必須 - アサーションに対して期待される値。header の場合、有効な値は、property で定義されたヘッダーキーに対する有効な値のいずれかです。statusCode の場合、有効な値は有効なステータスコードです。responseTime の場合、有効な値は期待される応答時間です。property - オプション - type を header に設定する場合は、これを使用してヘッダーのパラメーターキーを定義する必要があります。有効な値は、Content-Type や Authorization などのヘッダーキーです。request - API テストで必須 - エンドポイントに対するリクエストの実行に必要な情報をすべて含むオブジェクト。method - 必須 - テストする API のメソッド。有効な値は、GET、POST、PUT、PATCH、および DELETE です。ブラウザテストの場合は GET を使用します。url - 必須 - Datadog がテストする API のエンドポイント。ブラウザテストの場合は、Datadog がテストする Web サイトの URL。timeout - オプション - API リクエストがいつタイムアウトするか。headers - オプション - API リクエストのヘッダー。body - オプション - API リクエストの本文。テキスト文字列を受け取ります (JSON テキスト文字列など)。headers パラメーターで、Content-Type property パラメーターと application/json、text/plain などを使用してタイプを指定します。locations - 必須 - テストの送信元になる場所のリスト。少なくとも 1 つの値が必要で、すべての場所を使用できます。有効な場所のリストについては、使用可能な場所の取得メソッドを使用してください。message - 必須 - テストの説明。name - 必須 - テストの一意の名前。options - 必須 - 高度なオプションを使用します。カスタムリクエストヘッダー、認証資格情報、本文コンテンツ、cookie を指定したり、リダイレクトされるままテストを行ったりすることができます。値が指定されないオプションパラメーターはすべてデフォルト値を取ります。リクエストオブジェクトで有効な値は次のとおりです。tick_every:** - 必須 - どのくらいの頻度でテストを実行するか (秒単位。現在使用できる値は 60、300、900、1800、3600、21600、43200、86400、604800)。min_failure_duration - オプション - どのくらいの時間テストが失敗するとアラートになるか (整数の秒数。最大値は 7200)。デフォルトは 0 です。min_location_failed - オプション -min_failure_duration 期間の少なくともある瞬間に少なくとも何個の場所が同時に失敗する必要があるか (min_location_failed および min_failure_duration は、高度なアラート規則の一部です。- 1 以上の整数)。デフォルトは 1 です。follow_redirects - オプション - ブール値 - リダイレクトに従うかどうか (最大 10 回のリダイレクトに従い、それを超えると「Too many redirects」エラーをトリガーします)。有効な値は true または false です。デフォルト値は false です。device_ids - ブラウザテストで必須 - テストに使用するデバイスの種類。使用できるデバイスのリストを取得するには、ブラウザチェック用デバイスの取得メソッドを使用し、その応答に含まれる id を使用します。少なくとも 1 つのデバイスが必要です。tags - オプション - Datadog でテストを表示する際に、テストを絞り込むために使用するタグ。カスタムタグの詳細については、タグの使用方法を参照してください。type - 必須 - テストの種類。有効な値は api と browser です。POST /v1/synthetics/tests/
# This is not yet supported by the Python Client for the Datadog API# This is not yet supported by the Ruby Client for the Datadog API### To create an API test
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
"https://api.datadoghq.com/api/v1/synthetics/tests?api_key=${api_key}&application_key=${app_key}" \
-H 'Content-Type: application/json' \
-d '{
"config":{
"assertions":[
{
"operator":"is",
"type":"statusCode",
"target":403
},
{
"operator":"is",
"property":"content-type",
"type":"header",
"target":"text/html"
},
{
"operator":"lessThan",
"type":"responseTime",
"target":2000
}
],
"request":{
"method":"GET",
"url":"https://datadoghq.com",
"timeout":30,
"headers":{
"header1":"value1",
"header2":"value2"
},
"body":"body to send with the request"
}
},
"locations":[
"aws:us-east-2",
"aws:eu-central-1",
"aws:ca-central-1",
"aws:eu-west-2",
"aws:ap-northeast-1",
"aws:us-west-2",
"aws:ap-southeast-2"
],
"message":"test",
"name":"Test",
"options":{
"tick_every":60,
"min_failure_duration":0,
"min_location_failed":1,
"follow_redirects":true
},
"tags":[
"foo:bar"
],
"type":"api"
}'
### To create a browser test
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"locations":[
"aws:ca-central-1",
"aws:us-east-2"
],
"options":{
"device_ids":[
"laptop_large"
],
"tick_every":3600,
"min_failure_duration":0,
"min_location_failed":1
},
"name":"Test Doc",
"config":{
"assertions":[
],
"request":{
"method":"GET",
"url":"https://example.com/"
}
},
"message":"Test message",
"tags":[
],
"type":"browser"
}' \
"https://api.datadoghq.com/api/v1/synthetics/tests?api_key=${api_key}&application_key=${app_key}"{
"status":"live",
"public_id":"sti-s2m-ciz",
"tags":[
"foo:bar"
],
"locations":[
"aws:us-east-2",
"aws:eu-central-1",
"aws:ca-central-1",
"aws:eu-west-2",
"aws:ap-northeast-1",
"aws:us-west-2",
"aws:ap-southeast-2"
],
"message":"test",
"deleted_at":null,
"name":"Test",
"type":"api",
"created_at":"2019-04-18T14:35:28.378610+00:00",
"modified_at":"2019-04-18T14:35:28.378610+00:00",
"config":{
"request":{
"url":"https://datadoghq.com",
"headers":{
"header2":"value2",
"header1":"value1"
},
"body":"body to send with the request",
"method":"GET",
"timeout":30
},
"assertions":[
{
"operator":"is",
"type":"statusCode",
"target":403
},
{
"operator":"is",
"property":"content-type",
"type":"header",
"target":"text/html"
},
{
"operator":"lessThan",
"type":"responseTime",
"target":2000
}
]
},
"options":{
"follow_redirects":true,
"min_failure_duration":0,
"tick_every":60,
"min_location_failed":1
}
}このメソッドを使用して、既存の Synthetics テストを開始または一時停止します。
new_status - 必須 - テストを開始するか、一時停止するかを定義するキー/値ペア。有効な値は live と paused です。ステータスが変更された場合は true が返され、同じままの場合は false が返されます。POST /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>/status
# This is not yet supported by the Python Client for the Datadog API# This is not yet supported by the Ruby Client for the Datadog API#!/bin/bash
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
public_id=<SYNTHETICS_TEST_PUBLIC_ID>
curl -X PUT -H "Content-type: application/json" \
-d '{"new_status":"paused"}' \
"https://api.datadoghq.com/api/v1/synthetics/tests/${public_id}/status?api_key=${api_key}&application_key=${app_key}"
true
Use this method to update an existing Synthetics test. In order to update a test, you have to submit the same payload as creating a test.
The parameters required are different for API and browser tests and they are marked accordingly—if a parameter is marked as required, it is required for both types of tests.
A browser test is treated like a GET API test. This method gives you the ability to update the browser test, but you have to use the UI to record your test.
In order to update a request, you have to submit a full object, but only these parameters are editable: name, tags, config (anything defined in the assertions and anything defined in the request), message, options, locations, and status.
assertions - required - This is where you are defining exactly what should happen for a test to be considered passed. Each assertion has a: type, operator, target, and possibly a property.type - required API test - The part of the response that you want to assess. Possible types are header, body, responseTime, and statusCode. When you define a header, you must specify the header parameter key in the property parameter, and the header parameter value with the target parameter. For all other types, use the target to specify the body, the response time, and the error messages. For example, a "type":"statusCode" might have a "target":403.operator - required API test - Defines how to compare the target and the actual value from the response. Valid operators depend on the type of assertions. This is the list of valid operators per type:type | Valid operator | Value type |
|---|---|---|
| Status Code | is, is not | Integer |
| Response time | less than | Integer |
| Headers | contains, does not contain, is, is not, matches, does not match | for contains/does not contain/is/is not: String for matches/does not match: RegexString |
| Body | contains, does not contain, is, is not, matches, does not match | for contains/does not contain/is/is not: String for matches/does not match: RegexString |
target - required API test - The expected value for the assertion. For header, valid values are any of the valid values for the header key that you define in property. For statusCode, valid values are valid status codes. For responseTime, valid values are the expected response times.property - optional - When you are setting up a header type, this is required to define the headers parameter key. Valid values are any header keys, like Content-Type or Authorization.request - required API test - An object containing all the necessary information to perform the request to your endpoint.method - required - The method of the API to test. Valid values are GET, POST, PUT, PATCH, and DELETE. Use GET for a browser test.url - required - The endpoint for the API Datadog is testing. For a browser test, the URL for the website Datadog is testing.timeout - optional - When the API request will timeout.headers - optional - Headers in the API request.body - optional The body for the API request. Accepts text strings (including a JSON as a text string). Specify the type using Content-Type property parameter and the type (like application/json or text/plain in the headers paramater.locations - required - A list of the locations that you want the tests to be sent from. At least one value is required, and you can use all locations. For a list of valid locations, use the GET available locations method. At least one value is required, and you can use all locations.message - required - A description of the test.name - required - A unique name for the test.options - required - Use advanced options to specify custom request headers, authentication credentials, body content, cookies, or to have the test follow redirects. All optional parameters take their default value if you don’t specify a value. Valid values in the request object are:tick_every: - required - How often the test should run (in seconds - current possible values are 60, 300, 900, 1800, 3600, 21600, 43200, 86400, 604800).min_failure_duration - optional - How long the test should be in failure before alerting (integer, number of seconds, max 7200). Default is 0.min_location_failed - optional - The minimum number of locations that must have been in failure at the same time during at least one moment in the min_failure_duration period (min_location_failed and min_failure_duration are part of the advanced alerting rules - integer, >= 1. Default is 1.follow_redirects - optional - boolean - whether to follow redirects or not (max ten redirects can be followed before triggering a “Too many redirects” error). Valid values are true or false. Default value is false.device_ids - required browser test - The type of device you want to use to test. To get a list of available devices, use the GET devices for browser checkes method and use the id from the response. At least one device is required.tags - optional - Tags you want to use to filter your test when you are viewing it in Datadog. For more info on custom tags, see Using tags.type - required - The type of test. Valid values are api and browser.PUT /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>
# This is not yet supported by the Python Client for the Datadog API# This is not yet supported by the Ruby Client for the Datadog API#!/bin/bash
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
public_id=<SYNTHETICS_TEST_PUBLIC_ID>
curl -X PUT -H "Content-type: application/json" \
-d '{
"config":{
"assertions":[
{
"operator":"is",
"type":"statusCode",
"target":403
},
{
"operator":"is",
"property":"content-type",
"type":"header",
"target":"text/html"
},
{
"operator":"lessThan",
"type":"responseTime",
"target":2000
}
],
"request":{
"method":"GET",
"url":"https://datadoghq.com",
"timeout":30,
"headers":{
"header1":"value1",
"header2":"value2"
},
"body":"body to send with the request"
}
},
"locations":[
"aws:us-east-2",
"aws:eu-central-1",
"aws:ca-central-1",
"aws:eu-west-2",
"aws:ap-northeast-1",
"aws:us-west-2",
"aws:ap-southeast-2"
],
"message": "test-edited",
"name":"Test",
"options":{
"tick_every":60,
"min_failure_duration":0,
"min_location_failed":1,
"follow_redirects":true
},
"tags":[
"foo:bar"
],
"type":"api"
}' \
"https://api.datadoghq.com/api/v1/synthetics/tests/${public_id}?api_key=${api_key}&application_key=${app_key}"
{
"status":"live",
"public_id":"aaa-bbb-ccc",
"tags":[
"foo:bar"
],
"locations":[
"aws:us-east-2",
"aws:eu-central-1",
"aws:ca-central-1",
"aws:eu-west-2",
"aws:ap-northeast-1",
"aws:us-west-2",
"aws:ap-southeast-2"
],
"message":"test-edited",
"deleted_at":null,
"name":"Test",
"type":"api",
"created_at":"2019-04-12T12:29:34.379537+00:00",
"modified_at":"2019-04-12T12:29:34.379537+00:00",
"config":{
"request":{
"url":"https://datadoghq.com",
"headers":{
"sdf":"fds",
"Cookie":"qds"
},
"body":"fs",
"method":"GET",
"timeout":30
},
"assertions":[
{
"operator":"is",
"type":"statusCode",
"target":403
},
{
"operator":"is",
"property":"content-type",
"type":"header",
"target":"text/html"
},
{
"operator":"lessThan",
"type":"responseTime",
"target":2000
}
]
},
"options":{
"follow_redirects":true,
"min_failure_duration":0,
"tick_every":60,
"min_location_failed":1
}
}
Use this method to delete one or many tests.
public_ids - required - A JSON list of the ID or IDs of the tests that you want to delete.POST /v1/synthetics/tests/delete
# This is not yet supported by the Python Client for the Datadog API# This is not yet supported by the Ruby Client for the Datadog API#!/bin/bash
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-d '{
"public_ids":[
"aaa-bbb-ccc",
"bbb-ccc-ddd"
]
}' \
"https://api.datadoghq.com/api/v1/synthetics/tests/delete?api_key=${api_key}&application_key=${app_key}"
{
"deleted_tests":[
{
"public_id":"262647",
"deleted_at":"2019-04-16T21:20:57+0000"
},
{
"public_id":"262648",
"deleted_at":"2019-04-16T21:20:57+0000"
}
]
}このメソッドを使用して、特定のテストの最新の結果を取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>/results
# This is not yet supported by the Python Client for the Datadog API# This is not yet supported by the Ruby Client for the Datadog APIapi_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
public_id=<SYNTHETICS_TEST_PUBLIC_ID>
curl "https://api.datadoghq.com/api/v1/synthetics/tests/${public_id}/results?api_key=${api_key}&application_key=${app_key}"{
"last_timestamp_fetched":1555073253000,
"results":[
{
"status":0,
"probe_dc":"aws:eu-central-1",
"result_id":"13240452786084775503",
"result":{
"timings":{
"firstByte":563.9,
"tcp":28.8,
"ssl":60.4,
"dns":1.0678250044584274,
"download":0.1,
"total":654.3
}
},
"check_time":1555074213964
}
]
}このメソッドを使用して、特定のテストの特定の結果を取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>/results/<RESULT_ID>
# This is not yet supported by the Python Client for the Datadog API# This is not yet supported by the Ruby Client for the Datadog APIapi_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
public_id=<SYNTHETICS_TEST_PUBLIC_ID>
result_id=<TEST_RESULT_ID>
curl "https://api.datadoghq.com/api/v1/synthetics/tests/${public_id}/results/${result_id}?api_key=${api_key}&application_key=${app_key}"{
"status":0,
"check_time":1555074753734,
"check_version":4,
"result":{
"timings":{
"firstByte":717.5,
"tcp":281.8,
"ssl":565.2,
"dns":1.103536993265152,
"download":0.1,
"total":1565.7
},
"mainDC":"us1.prod",
"eventType":"finished",
"httpStatusCode":200,
"responseSize":26693
},
"probe_dc":"aws:ap-northeast-1",
"result_id":"16334500735347249235",
"check":{
"config":{
"request":{
"url":"https://datadoghq.com/",
"method":"GET",
"timeout":30
},
"assertions":[
{
"operator":"is",
"type":"statusCode",
"target":200
}
]
}
}
}
このメソッドを使用して、すべての既存のテストのリストを取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/synthetics/tests
# This is not yet supported by the Python Client for the Datadog API# This is not yet supported by the Ruby Client for the Datadog APIapi_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl "https://api.datadoghq.com/api/v1/synthetics/tests?api_key=${api_key}&application_key=${app_key}"{
"tests":[
{
"status":"live",
"public_id":"84r-szk-xpt",
"tags":[
"foo:bar"
],
"locations":[
"aws:us-east-2",
"aws:eu-central-1",
"aws:ca-central-1",
"aws:eu-west-2",
"aws:ap-northeast-1",
"aws:us-west-2",
"aws:ap-southeast-2"
],
"message":"test",
"name":"Test",
"type":"api",
"created_at":"2019-04-18T14:31:04.087360+00:00",
"modified_at":"2019-04-18T14:31:04.087360+00:00",
"config":{
"request":{
"url":"https://datadoghq.com",
"headers":{
"header2":"value2",
"header1":"value1"
},
"body":"body to send with the request",
"method":"GET",
"timeout":30
},
"assertions":[
{
"operator":"is",
"type":"statusCode",
"target":403
},
{
"operator":"is",
"property":"content-type",
"type":"header",
"target":"text/html"
},
{
"operator":"lessThan",
"type":"responseTime",
"target":2000
}
]
},
"options":{
"follow_redirects":true,
"min_failure_duration":0,
"tick_every":60,
"min_location_failed":1
}
},
{
"status":"paused",
"public_id":"sti-hyu-ciz",
"tags":[
"foo:bar"
],
"locations":[
"aws:us-east-2",
"aws:eu-central-1",
"aws:ap-northeast-1",
"aws:us-west-2",
"aws:ap-southeast-2"
],
"message":"test-edited",
"name":"Test",
"type":"api",
"created_at":"2019-04-18T14:35:28.378610+00:00",
"modified_at":"2019-04-18T15:04:56.181518+00:00",
"config":{
"request":{
"url":"https://datadoghq.com",
"headers":{
"header2":"value2",
"header1":"value1"
},
"body":"body to send with the request",
"method":"GET",
"timeout":30
},
"assertions":[
{
"operator":"is",
"type":"statusCode",
"target":403
},
{
"operator":"is",
"property":"content-type",
"type":"header",
"target":"text/html"
},
{
"operator":"lessThan",
"type":"responseTime",
"target":2000
}
]
},
"options":{
"follow_redirects":true,
"min_failure_duration":0,
"tick_every":60,
"min_location_failed":1
}
},
{
"status":"paused",
"public_id":"s6z-mno-2g6",
"tags":[
],
"locations":[
"aws:ca-central-1",
"aws:us-east-2"
],
"message":"Test message",
"name":"Test Doc",
"type":"browser",
"created_at":"2019-04-18T14:39:38.057734+00:00",
"modified_at":"2019-04-18T14:39:38.057734+00:00",
"config":{
"request":{
"url":"https://docs.datadoghq.com/",
"method":"GET"
},
"assertions":[
]
},
"options":{
"min_failure_duration":0,
"device_ids":[
"laptop_large"
],
"tick_every":3600,
"min_location_failed":1
}
}
]
}このメソッドを使用して、特定のテストに関する情報を取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>
# This is not yet supported by the Python Client for the Datadog API# This is not yet supported by the Ruby Client for the Datadog APIapi_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
public_id=<SYNTHETICS_TEST_PUBLIC_ID>
curl "https://api.datadoghq.com/api/v1/synthetics/tests/${public_id}?api_key=${api_key}&application_key=${app_key}"{
"status":"live",
"public_id":"84r-szk-xpt",
"tags":[
"foo:bar"
],
"locations":[
"aws:us-east-2",
"aws:eu-central-1",
"aws:ca-central-1",
"aws:eu-west-2",
"aws:ap-northeast-1",
"aws:us-west-2",
"aws:ap-southeast-2"
],
"message":"test",
"modified_by":{
"email":"example@example.com",
"handle":"example@example.com",
"id":1226568,
"name":"Jane Doe"
},
"name":"Test",
"type":"api",
"created_at":"2019-04-18T14:31:04.087360+00:00",
"modified_at":"2019-04-18T14:31:04.087360+00:00",
"created_by":{
"email":"example@example.com",
"handle":"example@example.com",
"id":1226568,
"name":"Jane Doe"
},
"overall_state_modified":"2019-04-18T14:31:23.689576+00:00",
"overall_state":0,
"config":{
"request":{
"url":"https://datadoghq.com",
"headers":{
"header2":"value2",
"header1":"value1"
},
"body":"body to send with the request",
"method":"GET",
"timeout":30
},
"assertions":[
{
"operator":"is",
"type":"statusCode",
"target":403
},
{
"operator":"is",
"property":"content-type",
"type":"header",
"target":"text/html"
},
{
"operator":"lessThan",
"type":"responseTime",
"target":2000
}
]
},
"options":{
"follow_redirects":true,
"min_failure_duration":0,
"tick_every":60,
"min_location_failed":1
}
}ブラウザチェック用デバイスのリストを取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/synthetics/browser/devices
# This is not yet supported by the Python Client for the Datadog API# This is not yet supported by the Ruby Client for the Datadog APIapi_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl "https://api.datadoghq.com/api/v1/synthetics/browser/devices?api_key=${api_key}&application_key=${app_key}"{
"devices":[
{
"width":1440,
"height":1100,
"id":"laptop_large",
"isMobile":false,
"name":"Laptop Large"
},
{
"width":768,
"height":1020,
"id":"tablet",
"isMobile":true,
"name":"Tablet"
},
{
"width":320,
"height":550,
"id":"mobile_small",
"isMobile":true,
"name":"Mobile Small"
}
]
}
使用可能な場所のリストを取得します。
このエンドポイントは、JSON 引数を受け取りません。
GET /v1/synthetics/locations
# This is not yet supported by the Python Client for the Datadog API# This is not yet supported by the Ruby Client for the Datadog APIapi_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl "https://api.datadoghq.com/api/v1/synthetics/locations?api_key=${api_key}&application_key=${app_key}"{
"locations":[
{
"is_active":true,
"region":"Americas",
"display_name":"Ohio (AWS)",
"id":30005,
"name":"aws:us-east-2"
},
{
"is_active":true,
"region":"Euro