add_aws_log_lambda_arn
Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection.
Parameters
$body
Type: object
{
"lambda_arn" : "ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup (https://docs.datadoghq.com/integrations/amazon_web_services/?tab=allpermissions#set-up-the-datadog-lambda-function).",
"account_id" : "Your AWS Account ID without dashes"
}
add_items_to_dashboard_list
Add items to dashboard list
Parameters
list_id (required)
Type: number
$body
Type: object
{
"dashboards" : [ {
"id" : "the Dashboard ID",
"type" : "the type of dashboard"
} ]
}
add_new_services_and_schedules
Add new services and schedules to your Datadog-PagerDuty integration.
Parameters
$body
Type: object
{
"schedules" : [ "string" ],
"services" : [ {
"service_key" : "Your service name's associated service key in PagerDuty.",
"service_name" : "Your service name in PagerDuty."
} ]
}
add_tags_to_host
This endpoint allows you to add new tags to a host, optionally specifying where these tags come from.
Parameters
host_name (required)
Type: string
$body
Type: object
{
"source" : "The source of the tags (e.g. chef, puppet). Complete list of source attribute values at https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value",
"tags" : [ "string" ]
}
bulk_delete_service_level_objective_timeframes
Bulk delete service level objective timeframes
Parameters
$body
An non-empty object is expected with the key as the SLO ID and the value as a non-empty list of timeframe(s) to remove.
Type: object
{ }
cancel_monitor_downtimes_by_scope
Cancel monitor downtimes by scope
Parameters
$body
Type: object
{
"scope" : "Cancel all downtimes with the given scope(s), e.g.: env:prod, role:db, role:db-slave"
}
check_if_service_level_objective_can_be_deleted
Check if a SLO can be safely deleted.
Parameters
slo_id (required)
Type: string
create_api_key
Create an API key with a given name.
Parameters
api_key (required)
Type: string
$body
Name of your API key.
Type: string
create_application_key
Create an application key with a given name.
Parameters
application_key (required)
Type: string
$body
Name of your application key.
Type: string
create_aws_integration
Create a Datadog-Amazon Web Services integration.
Parameters
$body
Type: object
{
"access_key_id" : "If your AWS account is a GovCloud or China account, enter the corresponding Access Key ID.",
"role_name" : "Your Datadog role delegation name. For more information about you AWS account Role name, see https://docs.datadoghq.com/integrations/amazon_web_services/#installation",
"account_id" : "Your AWS Account ID without dashes",
"filter_tags" : [ "string" ],
"host_tags" : [ "string" ],
"account_specific_namespace_rules" : { }
}
create_azure_integration
Create a Datadog-Azure integration.
Parameters
$body
Type: object
{
"host_filters" : "Limit the Azure instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. E.g. ':,:'",
"tenant_name" : "Your Azure Active Directory ID.",
"client_secret" : "Your Azure web application secret key.",
"client_id" : "Your Azure web application ID."
}
create_child_organization
This endpoint requires the multi-org account feature and must be enabled by contacting support. 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.
Parameters
$body
Type: object
{
"name" : "The name of the new child-organization, limited to 32 characters.",
"subscription" : {
"type" : "Required string. Possible values: trial | free | pro"
},
"billing" : {
"type" : "Required string"
}
}
create_comment
Create a comment
Parameters
$body
Type: object
{
"handle" : "The handle of the user making the comment. Default value is the application key owner.",
"related_event_id" : "The id of another comment or event to reply to.",
"message" : "The comment text"
}
create_dashboard
Create a dashboard
Parameters
$body
Type: object
{
"layout_type" : "Layout type of the dashboard.",
"description" : "Description of the dashboard.",
"notify_list" : [ "string" ],
"is_read_only" : "Whether this dashboard is read-only. If True, only the author and admins can make changes to it.",
"title" : "Title of the dashboard.",
"widgets" : [ {
"layout" : {
"x" : "The position of the widget on the x (horizontal) axis.",
"width" : "The width of the widget.",
"y" : "The position of the widget on the y (vertical) axis.",
"height" : "The height of the widget."
},
"definition" : {
"alert_id" : "ID of the alert to use in the widget",
"viz_type" : "Whether to display the Alert Graph as a timeseries or a top list.",
"type" : "Type of the widget",
"title" : "Title of the widget"
},
"id" : "ID of the widget."
} ],
"template_variables" : {
"default" : "The default value for the template variable on dashboard load.",
"prefix" : "The tag prefix associated with the variable. Only tags with this prefix appear in the variable dropdown.",
"name" : "The name of the variable."
}
}
create_dashboard_list
Create a dashboard list
Parameters
$body
Type: object
{
"name" : "The name of the dashboard list"
}
create_embed
Creates a new embeddable graph.
Parameters
$body
Type: object
{
"timeframe" : "The timeframe for the graph.",
"size" : "The size of the graph.",
"legend" : "The flag determining if the graph includes a legend.",
"title" : "Title of the graph",
"graph_json" : { }
}
create_gcp_integration
Create a Datadog-GCP integration.
Parameters
$body
All of the following fields’ values are provided by the JSON service account key file created in the GCP Console for service accounts; Refer to the Datadog-Google Cloud Platform integration installation instructions (https://docs.datadoghq.com/integrations/google_cloud_platform/#installation) to see how to generate one for your organization. For further references, consult the Google Cloud service account documentation.
Type: object
{
"host_filters" : "Limit the GCE instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. E.g. ':,:'",
"token_uri" : "Required string",
"private_key_id" : "Your private key ID found in your JSON service account key.",
"client_x509_cert_url" : "Should be https://www.googleapis.com/robot/v1/metadata/x509/ where is the email found in your JSON service account key.",
"automute" : "Silence monitors for expected GCE instance shutdowns.",
"project_id" : "Your Google Cloud project ID found in your JSON service account key.",
"auth_uri" : "Required string",
"auth_provider_x509_cert_url" : "Required string",
"client_email" : "Your email found in your JSON service account key.",
"private_key" : "Your private key name found in your JSON service account key.",
"type" : "The value for service_account found in your JSON service account key.",
"client_id" : "Your ID found in your JSON service account key."
}
create_monitor
Create a monitor programatically. If you manage and deploy monitors programmatically, it’s easier to define the monitor in the Datadog UI and export its valid JSON.
Parameters
$body
Type: object
{
"query" : "The query defines when the monitor triggers. Query syntax depends on what type of monitor you are creating.",
"name" : "The name of the alert.",
"options" : { },
"type" : "The type of the monitor.",
"message" : "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" : [ "string" ]
}
create_pagerduty_integration
Create a Datadog-PagerDuty integration.
Parameters
$body
Type: object
{
"schedules" : [ "string" ],
"api_token" : "Your PagerDuty API token.",
"subdomain" : "Your PagerDuty account’s personalized subdomain name.",
"services" : [ {
"service_key" : "Your service name's associated service key in PagerDuty.",
"service_name" : "Your service name in PagerDuty."
} ]
}
create_pipeline
Create a Pipeline in your organization.
Parameters
$body
Type: object
{
"is_enabled" : "Boolean value to enable your pipeline.",
"name" : "Your pipeline name",
"processors" : [ {
"is_enabled" : "If the processor is enabled or not",
"grok" : {
"match_rules" : "List of Match rules for your grok parser.",
"support_rules" : "List of Support rules for your grok parser."
},
"name" : "string",
"source" : "Name of the log attribute to parse",
"type" : "Required string",
"samples" : [ "string" ]
} ],
"filter.query" : "Only logs matching the filter criteria are processed by this pipeline. Use the Log search syntax at https://docs.datadoghq.com/logs/explorer/search/#search-syntax"
}
create_service_level_objective
Create a JSON to define your SLO.
Parameters
$body
Type: object
{
"thresholds" : [ {
"warning_display" : "A warning target display value that includes the requires level of precision.",
"timeframe" : "The timeframe to apply tho the target value.",
"target_display" : "The target display value that includes the requires level of precision.",
"warning" : "A warning target value to indicate when the SLI is close to breaching the target.",
"target" : "The target value to associate with the SLI that defines the SLO."
} ],
"name" : "Required string",
"description" : "string",
"type" : "Required string. Possible values: metric | monitor",
"tags" : [ "string" ]
}
create_slack_integration
Either create_slack_integration or add_channel_to_slack_integration
Parameters
$body
Type: object
{
"channels" : {
"channel_name" : "Your channel name",
"transfer_all_user_comments" : "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" : "Account to which the channel belongs to."
},
"service_hooks" : [ {
"service_hooks" : {
"account" : "Your Slack account name",
"url" : "Your Slack Service Hook URL."
}
} ]
}
create_test
Create a Synthetics test to initiate and configure the tests you want Datadog to send to your API endpoints or to your browser app. You can configure the endpoints being tested, the number of tests, and where they are coming from. 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.
Parameters
$body
Type: object
{
"subtype" : "For a SSL API test, specify ssl as the value. Otherwise, you should omit this argument.",
"name" : "A unique name for the test.",
"options" : [ {
"min_location_failed" : "The minimum number of locations 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).",
"tick_every" : "How often the test should run, in seconds.",
"min_failure_duration" : "How long the test should be in failure before alerting, in seconds.",
"follow_redirects" : "whether to follow redirects (a max of ten redirects can be followed before triggering a “Too many redirects” error).",
"device_ids" : "The type of device used to test. To get a list of available devices, use the id from the response of the GET devices for browser checks method. At least one device is required."
} ],
"locations" : [ "string" ],
"type" : "The type of test.",
"message" : "A description of the test.",
"config" : {
"request" : {
"headers" : { },
"method" : "The method of the API to test. Use GET for a browser test.",
"port" : "If creating a SSL test, specify the port to connect to.",
"basicAuth" : "If your endpoint is behind basic Auth, use this parameter to define your username and password with the following value: {\"username\": \"\", \"password\": \"\"}.",
"host" : "If creating a SSL test, specify the host to connect to.",
"body" : "The body for the API request. Accepts text strings (including JSON as a text string). Specify the type using the Content-Type property parameter and type, for example application/json or text/plain in the headers parameter.",
"url" : "The endpoint for the API Datadog is testing. For a browser test, the URL for the website Datadog is testing.",
"timeout" : "When the request should timeout.",
"cookies" : "Cookies to send along with your API test request."
},
"assertions" : [ {
"property" : "When you are setting up a header for the type parameter, this is required to define the headers parameter key. Valid values are any header keys, like Content-Type or Authorization.",
"type" : "The part of the response that you want to assess.",
"operator" : "Defines how to compare the target and the actual value from the response. Valid operators depend on the type of assertions. See https://docs.datadoghq.com/api/?lang=bash#create-a-test for details.",
"target" : "The expected value for the assertion."
} ]
},
"tags" : [ "string" ]
}
create_user
Create a user.
Parameters
$body
Type: object
{
"access_role" : "The access role of the user. Choose from st (standard user), adm (admin user), or ro (read-only user).",
"name" : "The name of the user.",
"handle" : "The user handle, must be a valid email."
}
create_webhooks_integration
Create a Datadog-Webhooks integration.
Parameters
$body
The array of Webhooks objects.
Type: array
[ {
"hooks" : {
"headers" : "Headers attached to your Webhook.",
"encode_as_form" : "If use_custom_payload is true, set this to true to have your payload to be URL-encoded.",
"name" : "Your Webhook name. https://docs.datadoghq.com/monitors/notifications",
"use_custom_payload" : "If true, allow you to specify a custom payload for your Webhook.",
"custom_payload" : "If use_custom_payload is true, specify your own payload to add your own custom fields to the request. Use these variables: https://docs.datadoghq.com/integrations/webhooks/#usage",
"url" : "Your Webhook URL."
}
} ]
delete_api_key
Delete an API key.
Parameters
api_key (required)
Type: string
delete_application_key
Delete an application key.
Parameters
application_key (required)
Type: string
delete_aws_integration
Delete a Datadog-Amazon Web Services integration.
Parameters
$body
Type: object
{
"role_name" : "Your Datadog role delegation name. For more information about your AWS account Role name, see https://docs.datadoghq.com/integrations/amazon_web_services/#installation",
"account_id" : "Your AWS Account ID without dashes"
}
delete_aws_log_collection
Delete a Datadog-AWS log collection configuration by removing the specific Lambda ARN associated with a given AWS account.
Parameters
$body
Type: object
{
"lambda_arn" : "ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup (https://docs.datadoghq.com/integrations/amazon_web_services/?tab=allpermissions#set-up-the-datadog-lambda-function).",
"account_id" : "Your AWS Account ID without dashes"
}
delete_azure_integration
Delete a Datadog-Azure integration.
Parameters
$body
Type: object
{
"host_filters" : "Limit the Azure instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. E.g. ':,:'",
"tenant_name" : "Your Azure Active Directory ID.",
"client_id" : "Your Azure web application ID."
}
delete_dashboard
Delete a dashboard
Parameters
dashboard_id (required)
Type: number
delete_dashboard_list
Delete a dashboard list
Parameters
list_id (required)
Type: number
delete_gcp_integration
Delete a Datadog-GCP integration.
Parameters
$body
Type: object
{
"project_id" : "Your Google Cloud project ID found in your JSON service account key.",
"client_email" : "Your email found in your JSON service account key."
}
delete_items_from_dashboard_list
Delete items from a dashboard list
Parameters
list_id (required)
Type: number
$body
Type: object
{
"dashboards" : [ {
"id" : "the Dashboard ID",
"type" : "the type of dashboard"
} ]
}
delete_many_service_level_objectives
Delete many Service Level Objectives.
Parameters
$body
A non-empty list of SLO ID(s).
Type: array
[ "string" ]
delete_monitor
This operation has no parameters
delete_pagerduty_integration
This operation has no parameters
delete_pipeline
Delete a specific pipeline from your organization.
Parameters
pipeline_id (required)
Type: string
delete_service_level_objective
Permanently delete a SLO. If an SLO is used in a dashboard, the DELETE endpoint returns a 409 conflict error because the SLO is referenced in a dashboard.
Parameters
slo_id (required)
Type: string
force
Force delete the SLO. The SLO is deleted even if it’s referenced in a dashboard.
Type: boolean
delete_slack_integration
This operation has no parameters
delete_tests
Use this method to delete one or many tests.
Parameters
$body
Type: object
{
"public_ids" : [ "string" ]
}
delete_webhooks_integration
This operation has no parameters
disable_user
Disable a user in the organization. Can only be used with application keys belonging to administrators.
Parameters
user_id (required)
Type: string
edit_api_key
Edit an API key name.
Parameters
api_key (required)
Type: string
$body
Name of your API key.
Type: string
edit_application_key
Edit an application key name.
Parameters
application_key (required)
Type: string
$body
Name of your application key.
Type: string
edit_comment
Edit a comment
Parameters
comment_id (required)
Type: number
$body
Type: object
{
"handle" : "The handle of the user making the comment. Default value is the application key owner.",
"message" : "The comment text"
}
edit_metric_metadata
Edit fields of a metric’s metadata.
Parameters
metric_name (required)
Type: string
$body
Type: object
{
"unit" : "Primary unit of the metric such as byte or operation.",
"per_unit" : "Per unit of the metric such as second in bytes per second",
"stated_interval" : "If applicable, statds flush interval in seconds for the metric.",
"description" : "string",
"short_name" : "Required string",
"type" : "Required string. Possible values: count | gauge | rate"
}
edit_monitor
Edit a monitor.
Parameters
monitor_id (required)
Type: string
$body
Type: object
{
"query" : "The query defines when the monitor triggers. Query syntax depends on what type of monitor you are creating.",
"name" : "The name of the alert.",
"options" : { },
"message" : "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" : [ "string" ]
}
edit_service_level_objective
Edit a specific SLO’s details.
Parameters
slo_id (required)
Type: string
$body
Type: object
{
"thresholds" : [ {
"warning_display" : "A warning target display value that includes the requires level of precision.",
"timeframe" : "The timeframe to apply tho the target value.",
"target_display" : "The target display value that includes the requires level of precision.",
"warning" : "A warning target value to indicate when the SLI is close to breaching the target.",
"target" : "The target value to associate with the SLI that defines the SLO."
} ],
"name" : "string",
"description" : "string",
"tags" : [ "string" ]
}
edit_test
Use this method to update an existing Synthetics test.
Parameters
test_id (required)
Type: string
$body
Type: object
{
"subtype" : "For a SSL API test, specify ssl as the value. Otherwise, you should omit this argument.",
"name" : "A unique name for the test.",
"options" : [ {
"min_location_failed" : "The minimum number of locations 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).",
"tick_every" : "How often the test should run, in seconds.",
"min_failure_duration" : "How long the test should be in failure before alerting, in seconds.",
"follow_redirects" : "whether to follow redirects (a max of ten redirects can be followed before triggering a “Too many redirects” error).",
"device_ids" : "The type of device used to test. To get a list of available devices, use the id from the response of the GET devices for browser checks method. At least one device is required."
} ],
"locations" : [ "string" ],
"type" : "The type of test.",
"message" : "A description of the test.",
"config" : {
"request" : {
"headers" : { },
"method" : "The method of the API to test. Use GET for a browser test.",
"port" : "If creating a SSL test, specify the port to connect to.",
"basicAuth" : "If your endpoint is behind basic Auth, use this parameter to define your username and password with the following value: {\"username\": \"\", \"password\": \"\"}.",
"host" : "If creating a SSL test, specify the host to connect to.",
"body" : "The body for the API request. Accepts text strings (including JSON as a text string). Specify the type using the Content-Type property parameter and type, for example application/json or text/plain in the headers parameter.",
"url" : "The endpoint for the API Datadog is testing. For a browser test, the URL for the website Datadog is testing.",
"timeout" : "When the request should timeout.",
"cookies" : "Cookies to send along with your API test request."
},
"assertions" : [ {
"property" : "When you are setting up a header for the type parameter, this is required to define the headers parameter key. Valid values are any header keys, like Content-Type or Authorization.",
"type" : "The part of the response that you want to assess.",
"operator" : "Defines how to compare the target and the actual value from the response. Valid operators depend on the type of assertions. See https://docs.datadoghq.com/api/?lang=bash#create-a-test for details.",
"target" : "The expected value for the assertion."
} ]
},
"tags" : [ "string" ]
}
enable_aws_service_log_collection
Enable Automatic Log collection for your AWS services.
Parameters
$body
Type: object
{
"account_id" : "Your AWS Account ID without dashes",
"services" : [ "string" ]
}
enable_embed
Enable a specified embed.
Parameters
embed_id (required)
Type: number
generate_external_ids
Generate a new AWS external id for a given AWS account id and role name pair.
Parameters
$body
Type: object
{
"role_name" : "Your Datadog role delegation name. For more information about your AWS account Role name, see https://docs.datadoghq.com/integrations/amazon_web_services/#installation",
"account_id" : "Your AWS Account ID without dashes"
}
get_api_key
Get an API key.
Parameters
api_key (required)
Type: string
get_application_key
Get an application key.
Parameters
application_key (required)
Type: string
get_available_locations
This operation has no parameters
get_dashboard
Get a dashboard
Parameters
dashboard_id (required)
Type: number
get_dashboard_list
Get a dashboard list
Parameters
list_id (required)
Type: number
get_devices_for_browser_checks
This operation has no parameters
get_event
This endpoint allows you to query for event details.
Parameters
end (required)
POSIX timestamp for end
Type: number
event_id (required)
Type: number
start (required)
POSIX timestamp for start
Type: number
priority
priority of your events
Type: string
Potential values: low, normal
sources
A comma-separated string of sources
Type: array
[ "string" ]
tags
A comma-separated string of tags. To use a negative tag filter, prefix your tag with '-'.
Type: array
[ "string" ]
unaggregated
Set unaggregated to true to return all events within the specified [start,end] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won’t be available in the output.
Type: boolean
get_history_of_service_level_objective
Get a specific SLO’s history.
Parameters
slo_id (required)
Type: string
from_ts
Type: number
to_ts
Type: number
get_host_tags
Return the list of tags that apply to a given host.
Parameters
host_name (required)
Type: string
get_host_totals
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.
Parameters
from
Number of seconds since UNIX epoch from which you want to get the total number of active and up hosts.
Type: number
get_hourly_usage_across_multi_org_account
Get hourly usage across your multi-org account
Parameters
start_month (required)
Datetime in ISO-8601 format, UTC, precise to month [YYYY-MM] for usage beginning in this month. Maximum of 15 months ago.
Type: string
end_month
Datetime in ISO-8601 format, UTC, precise to month [YYYY-MM] for usage ending this month.
Type: string
include_org_details
Include usage summaries for each sub-org.
Type: boolean
get_hourly_usage_for_custom_metrics
Get hourly usage for custom metrics
Parameters
start_hr (required)
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage beginning at this hour.
Type: string
end_hr
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage ending before this hour.
Type: string
get_hourly_usage_for_fargate
Get hourly usage for Fargate (https://docs.datadoghq.com/integrations/ecs_fargate)
Parameters
start_hr (required)
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage beginning at this hour.
Type: string
end_hr
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage ending before this hour.
Type: string
get_hourly_usage_for_hosts_and_containers
Get hourly usage for hosts and containers
Parameters
start_hr (required)
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage beginning at this hour.
Type: string
end_hr
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage ending before this hour.
Type: string
get_hourly_usage_for_logs
Get hourly usage for logs
Parameters
start_hr (required)
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage beginning at this hour.
Type: string
end_hr
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage ending before this hour.
Type: string
get_hourly_usage_for_synthetics
Get hourly usage for synthetics
Parameters
start_hr (required)
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage beginning at this hour.
Type: string
end_hr
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage ending before this hour.
Type: string
get_hourly_usage_for_trace_search
Get hourly usage for trace search
Parameters
start_hr (required)
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage beginning at this hour.
Type: string
end_hr
Datetime in ISO-8601 format, UTC, precise to hour. [YYYY-MM-DDThh] for usage ending before this hour.
Type: string
get_index
This endpoint returns an Index identified by its name.
Parameters
index_name (required)
Type: string
get_items_of_dashboard_list
Get items from a dashboard list
Parameters
list_id (required)
Type: number
get_metadata_for_metric
Get metadata about a specific metric.
Parameters
metric_name (required)
Type: string
get_monitor_downtime
Get a monitor downtime
Parameters
downtime_id (required)
Type: number
get_monitor_s_details
Get a monitor’s details.
Parameters
monitor_id (required)
Type: string
group_states
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.
Type: array
[ "string. Possible values: all | alert | warn | no data" ]
get_order_of_indexes
This operation has no parameters
get_order_of_pipeline
This operation has no parameters
get_organization
This operation has no parameters
get_pagerduty_integration
This operation has no parameters
get_pipeline
Get a specific pipeline from your organization.
Parameters
pipeline_id (required)
Type: string
get_result_for_test
Use this method to get a specific result for a specific test.
Parameters
result_id (required)
Type: string
test_id (required)
Type: string
get_service_level_objective
Get a specific SLO’s details.
Parameters
slo_id (required)
Type: string
get_slack_integration
This operation has no parameters
get_snapshot_of_graph
Take a snapshot of the graph.
Parameters
end (required)
POSIX timestamp for end
Type: number
start (required)
POSIX timestamp for start
Type: number
event_query
A query that adds event bands to the graph
Type: string
graph_def
A JSON document defining the graph. graph_def can be used instead of metric_query. The JSON document uses the grammar defined at https://docs.datadoghq.com/graphing/graphing_json/#grammar and should be formatted to a single line then URLEncoded.
Type: string
metric_query
The metric query
Type: string
title
A title for the graph. If no title is specified, the graph doesn’t have a title.
Type: string
get_specific_embed
Get the HTML fragment for a previously generated embed with embed_id.
Parameters
embed_id (required)
Type: number
get_test
Use this method to get a specific test.
Parameters
test_id (required)
Type: string
get_top_metrics_across_multi_org_account
Get top 500 custom metrics by hourly average.
Parameters
month (required)
Datetime in ISO-8601 format, UTC, precise to month [YYYY-MM] for usage beginning in this month.
Type: string
names
List of metric names.
Type: array
[ "string" ]
get_user
Get a user in the organization, specified by the user’s handle.
Parameters
user_id (required)
Type: string
get_webhooks_integration
This operation has no parameters
list_active_metrics
Get the list of actively reporting metrics from a given time until now.
Parameters
from (required)
Seconds since the UNIX epoch
Type: integer
host
Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag.
Type: string
list_api_keys
This operation has no parameters
list_application_keys
This operation has no parameters
list_aws_integrations
This operation has no parameters
list_aws_log_ready_services
This operation has no parameters
list_azure_integrations
This operation has no parameters
list_dashboard
This operation has no parameters
list_dashboard_lists
This operation has no parameters
list_details_of_monitor
Get all monitors' details.
Parameters
group_states
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.
Type: array
[ "string. Possible values: all | alert | warn | no data" ]
monitor_tags
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)
Type: array
[ "string" ]
name
Type: string
page
The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination.
Type: integer
page_size
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.
Type: integer
tags
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 at https://docs.datadoghq.com/api/?lang=bash#create-a-monitor
Type: array
[ "string" ]
with_downtimes
If this argument is set to true, then the returned data includes all current downtimes for each monitor.
Type: boolean
list_downtimes_for_monitor
Get all monitor downtimes
Parameters
$body
Type: object
{
"current_only" : "Only return downtimes that are active when the request is made."
}
list_embeds
This operation has no parameters
list_gcp_integrations
This operation has no parameters
list_host_tags
This operation has no parameters
list_indexes
This operation has no parameters
list_most_recent_results
Use this method to return up to 50 of the most recent results for a specific test.
Parameters
test_id (required)
Type: string
list_namespace_rules
This operation has no parameters
list_pipelines
This operation has no parameters
list_tests
This operation has no parameters
list_users
This operation has no parameters
mute_all_monitors
This operation has no parameters
mute_host
Mute a host
Parameters
host_name (required)
Type: string
$body
Type: object
{
"end" : "POSIX timestamp when the host is unmuted. If omitted, the host remains muted until explicitly unmuted.",
"override" : "If true and the host is already muted, replaces existing host mute settings.",
"message" : "Message to associate with the muting of this host."
}
mute_monitor
Muting prevents monitors from notifying through email and posts to the event stream. State changes are only visible by checking the alert page.
Parameters
monitor_id (required)
Type: string
$body
Type: object
{
"scope" : "The scope to apply the mute to, e.g. role:db. For example, if your alert is grouped by {host}, you might mute host:app1.",
"end" : "A POSIX timestamp for when the mute should end."
}
post_check_run
Post a check run
Parameters
$body
Type: object
{
"check" : "The text for the message",
"message" : "A description of why this status occurred",
"host_name" : "The name of the host submitting the check",
"status" : "An integer for the status of the check",
"tags" : [ "string" ],
"timestamp" : "POSIX timestamp of the event"
}
post_event
This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events.
Parameters
$body
Type: object
{
"aggregation_key" : "An arbitrary string to use for aggregation. Limited to 100 characters. If you specify a key, all events using that key are grouped together in the Event Stream.",
"device_name" : [ "string" ],
"host" : "Host name to associate with the event. Any tags associated with the host are also applied to this event.",
"related_event_id" : "ID of the parent event",
"text" : "The body of the event. Limited to 4000 characters. The text supports markdown.",
"title" : "The event title. Limited to 100 characters.",
"priority" : "The priority of the event.",
"source_type_name" : "The type of event being posted.",
"alert_type" : "If it’s an alert event, set its type between error, warning, info, and success.",
"date_happened" : "POSIX timestamp of the event. Must be sent as an integer (i.e. no quotes). Limited to events no older than 1 year, 24 days (389 days).",
"tags" : [ "string" ]
}
post_timeseries_points
The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. The limit for compressed payloads is 3.2 megabytes (3200000), and 62 megabytes (62914560) for decompressed payloads.
Parameters
$body
Type: object
{
"series" : [ {
"metric" : "The name of the timeseries",
"host" : "The name of the host that produced the metric.",
"interval" : "If the type of the metric is rate or count, define the corresponding interval.",
"type" : "Type of your metric",
"points" : [ [ "number" ] ],
"tags" : [ "string" ]
} ]
}
query_timeseries_points
Query for metrics from any time period. Use the query syntax described in https://docs.datadoghq.com/graphing/functions
Parameters
from (required)
Seconds from the UNIX epoch
Type: integer
to (required)
Seconds to the UNIX epoch
Type: integer
query
The query string
Type: string
remove_host_tags
This endpoint allows you to remove all user-assigned tags for a single host.
Parameters
host_name (required)
Type: string
resolve_monitor
Resolve monitor
Parameters
$body
Type: object
{
"resolve" : [ { } ]
}
revoke_embed
Revoke a specified embed.
Parameters
embed_id (required)
Type: number
search_hosts
This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included.
Parameters
count
Number of host results to return.
Type: number
filter
Query string to filter search results.
Type: string
from
Number of seconds since UNIX epoch from which you want to search your hosts.
Type: number
sort_dir
direction of sort
Type: string
Potential values: asc, desc
sort_field
Sort hosts by the given field.
Type: string
Potential values: status, apps, cpu, iowait, load
start
Host result to start search from
Type: number
search_logs
List endpoint returns logs that match a log search query.
Parameters
$body
Type: object
{
"time.to" : "Maximum timestamp for requested logs. Format can be either an ISO-8601 string with minute, second or millisecond precision, a UNIX timestamp (number representing the elapsed millisec since epoch), or a relative time (now -10m, now - 1h, now - 1d)",
"time.offset" : "Equivalent to time.timezone, but with a value in seconds. If both timezone and offset are specified, timezone is ignored.",
"query" : "The search query. Use the Log search syntax at https://docs.datadoghq.com/logs/explorer/search/#search-syntax",
"limit" : "Number of logs returned in the response.",
"index" : "For multi-index organizations, the log index in which the request is performed.",
"time.timezone" : "Can be specified both as an offset (e.g. “UTC+03:00”) or a regional zone (e.g. “Europe/Paris”)",
"sort" : "Time-ascending or time-descending results.",
"time.from" : "Minimum timestamp for requested logs. Format can be either an ISO-8601 string, a UNIX timestamp (number representing the elapsed millisec since epoch), or a relative time (now -10m, now - 1h, now - 1d)",
"startAt" : "Hash identifier of the first log to return in the list, available in a log id attribute. This parameter is used for the pagination feature. This parameter is ignored if the corresponding log is out of the scope of the specified time window."
}
search_metrics
Search for metrics from the last 24 hours in Datadog.
Parameters
q (required)
The query string to search metrics upon. Must be prefixed with metrics:
Type: string
search_monitor_group
Search and filter your monitor group details.
Parameters
page
Page to start paginating from.
Type: number
per_page
Number of monitors to return per page.
Type: number
query
Query to filter your monitors
Type: string
sort
Comma separated string for sort order (e.g. name,asc) supported fields: name, status, tags
Type: array
[ "string" ]
search_monitors
Search and filter your monitor details.
Parameters
page
Page to start paginating from.
Type: number
per_page
Number of monitors to return per page.
Type: number
query
Query to filter your monitors
Type: string
sort
Comma separated string for sort order (e.g. name,asc) supported fields: name, status, tags
Type: array
[ "string" ]
search_service_level_objectives
Search and filter your service level objectives.
Parameters
ids
Query multiple SLOs by their IDs.
Type: array
[ "string" ]
limit
Type: integer
offset
Type: integer
query
After entering a search query in your List Service Level Objectives page, use the query parameter value in the URL of the page as value for this parameter. For more information on building a query, see Searching SLOs. The query can contain any number of space-separated monitor attributes, for instance query="type:metric foo".
Type: string
set_automute_for_gcp_integration
Enable or disable automute for a given Datadog-GCP integration.
Parameters
$body
Type: object
{
"automute" : "Silence monitors for expected GCE instance shutdowns.",
"project_id" : "Your Google Cloud project ID found in your JSON service account key.",
"client_email" : "Your email found in your JSON service account key."
}
start_or_pause_test
Use this method to start or pause an existing Synthetics test.
Parameters
test_id (required)
Type: string
$body
Type: object
{
"new_status" : "A key-value pair where you define whether you want to start or pause a test."
}
unmute_all_monitors
This operation has no parameters
unmute_host
Unmute a host
Parameters
host_name (required)
Type: string
unmute_monitor
Unmute a single monitor.
Parameters
monitor_id (required)
Type: string
$body
Type: object
{
"scope" : "The scope to apply the mute to, e.g. role:db. For example, if your alert is grouped by {host}, you might mute host:app1.",
"all_scopes" : "If true, clear muting across all scopes."
}
update_aws_integration
Update a Datadog-Amazon Web Services integration.
Parameters
$body
Type: object
{
"access_key_id" : "If your AWS account is a GovCloud or China account, enter the corresponding Access Key ID.",
"role_name" : "Your Datadog role delegation name. For more information about you AWS account Role name, see https://docs.datadoghq.com/integrations/amazon_web_services/#installation",
"account_id" : "Your AWS Account ID without dashes",
"filter_tags" : [ "string" ],
"host_tags" : [ "string" ],
"account_specific_namespace_rules" : { }
}
update_dashboard
Update a dashboard
Parameters
dashboard_id (required)
Type: number
$body
Type: object
{
"layout_type" : "Layout type of the dashboard.",
"description" : "Description of the dashboard.",
"notify_list" : [ "string" ],
"is_read_only" : "Whether this dashboard is read-only. If True, only the author and admins can make changes to it.",
"title" : "Title of the dashboard.",
"widgets" : [ {
"layout" : {
"x" : "The position of the widget on the x (horizontal) axis.",
"width" : "The width of the widget.",
"y" : "The position of the widget on the y (vertical) axis.",
"height" : "The height of the widget."
},
"definition" : {
"alert_id" : "ID of the alert to use in the widget",
"viz_type" : "Whether to display the Alert Graph as a timeseries or a top list.",
"type" : "Type of the widget",
"title" : "Title of the widget"
},
"id" : "ID of the widget."
} ],
"template_variables" : {
"default" : "The default value for the template variable on dashboard load.",
"prefix" : "The tag prefix associated with the variable. Only tags with this prefix appear in the variable dropdown.",
"name" : "The name of the variable."
}
}
update_dashboard_list
Update a dashboard list
Parameters
list_id (required)
Type: number
$body
Type: object
{
"name" : "The name of the dashboard list"
}
update_host_filters_for_azure_integration
Update the defined list of host filters for a given Datadog-Azure integration.
Parameters
$body
Type: object
{
"host_filters" : "Limit the Azure instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. E.g. ':,:'",
"tenant_name" : "Your Azure Active Directory ID.",
"client_secret" : "Your Azure web application secret key.",
"client_id" : "Your Azure web application ID."
}
update_host_tags
This endpoint allows you to update/replace all tags in an integration source with those supplied in the request.
Parameters
host_name (required)
Type: string
$body
Type: object
{
"source" : "The source of the tags (e.g. chef, puppet). Complete list of source attribute values at https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value",
"tags" : [ "string" ]
}
update_index
This endpoint updates an Index identified by its name. It returns the Index object passed in the request body when the request is successful.
Parameters
index_name (required)
Type: string
$body
Type: object
{
"exclusion_filters" : [ {
"is_enabled" : "A boolean stating if the exclusion is active",
"filter.sample_rate" : "The fraction of logs excluded by the exclusion filter, when active. The sampling is uniform.",
"name" : "name of the exclusion filter",
"filter.query" : "Only logs matching the filter criteria AND the query of the parent index will be considered for this exclusion filter. Use the Log search syntax at https://docs.datadoghq.com/logs/explorer/search/#search-syntax"
} ],
"filter.query" : "Only logs matching the filter criteria will be considered for this index. Use the Log search syntax at https://docs.datadoghq.com/logs/explorer/search/#search-syntax"
}
update_items_of_dashboard_list
Update items in dashboard list
Parameters
list_id (required)
Type: number
$body
Type: object
{
"dashboards" : [ {
"id" : "the Dashboard ID",
"type" : "the type of dashboard"
} ]
}
update_order_of_indexes
This endpoint updates the IndexOrder of your organization. It returns the IndexOrder object passed in the request body when the request is successful.
Parameters
$body
Array of Strings identifying by their name(s) the index(es) of your organisation. Logs are tested against the query filter of each index one by one, following the order of the array. Logs are eventually stored in the first matching index.
Type: array
[ "string" ]
update_order_of_pipeline
Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change the structure and content of the data processed by other pipelines and their processors.
Parameters
$body
Type: object
{
"pipeline_ids" : [ "string" ]
}
update_organization
Update organization information.
Parameters
public_id (required)
Type: string
$body
Type: object
{
"settings" : {
"saml_idp_initiated_login" : {
"enabled" : "boolean"
},
"saml" : {
"enabled" : "boolean"
},
"saml_autocreate_users_domains" : {
"domains" : [ "string" ],
"enabled" : "boolean"
},
"saml_strict_mode" : {
"enabled" : "boolean"
}
},
"name" : "The organization name"
}
update_pipeline
This endpoint updates an Pipeline identified by its name. It returns the Pipeline object passed in the request body when the request is successful.
Parameters
pipeline_id (required)
Type: string
$body
Type: object
{
"is_enabled" : "Boolean value to enable your pipeline.",
"name" : "Your pipeline name",
"processors" : [ {
"is_enabled" : "If the processor is enabled or not",
"grok" : {
"match_rules" : "List of Match rules for your grok parser.",
"support_rules" : "List of Support rules for your grok parser."
},
"name" : "string",
"source" : "Name of the log attribute to parse",
"type" : "Required string",
"samples" : [ "string" ]
} ],
"filter.query" : "Only logs matching the filter criteria are processed by this pipeline. Use the Log search syntax at https://docs.datadoghq.com/logs/explorer/search/#search-syntax"
}
update_slack_integration
Update your integration configuration by replacing your current configuration with the new one sent to your Datadog organization.
Parameters
$body
Type: object
{
"service_hooks" : [ {
"service_hooks" : {
"account" : "Your Slack account name",
"url" : "Your Slack Service Hook URL."
}
} ]
}
update_user
Update a user. Can only be used with application keys belonging to administrators.
Parameters
user_id (required)
Type: string
$body
Type: object
{
"access_role" : "The access role of the user. Choose from st (standard user), adm (admin user), or ro (read-only user).",
"name" : "The new name of the user.",
"disabled" : "The new disabled status of the user.",
"id" : "The user handle, must be a valid email.",
"email" : "The new email of the user."
}
update_webhooks_integration
Add a specific Webhook to a Datadog Webhooks integration.
Parameters
$body
The array of Webhooks objects.
Type: array
[ {
"hooks" : {
"headers" : "Headers attached to your Webhook.",
"encode_as_form" : "If use_custom_payload is true, set this to true to have your payload to be URL-encoded.",
"name" : "Your Webhook name. https://docs.datadoghq.com/monitors/notifications",
"use_custom_payload" : "If true, allow you to specify a custom payload for your Webhook.",
"custom_payload" : "If use_custom_payload is true, specify your own payload to add your own custom fields to the request. Use these variables: https://docs.datadoghq.com/integrations/webhooks/#usage",
"url" : "Your Webhook URL."
}
} ]
upload_idp_metadata
Update the Identity Provider (IdP) metadata from your SAML IdP.
Parameters
public_id (required)
Type: string
$body
Type: object
{ }
validate_monitor
Validates a monitor definition (see https://docs.datadoghq.com/api/#create-a-monitor for details on constructing a monitor definition).
Parameters
$body
Type: object
{ }