Note: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
POST https://api.ap1.datadoghq.com/api/v2/data-observability/monitors/{monitor_id}/runhttps://api.ap2.datadoghq.com/api/v2/data-observability/monitors/{monitor_id}/runhttps://api.datadoghq.eu/api/v2/data-observability/monitors/{monitor_id}/runhttps://api.ddog-gov.com/api/v2/data-observability/monitors/{monitor_id}/runhttps://api.us2.ddog-gov.com/api/v2/data-observability/monitors/{monitor_id}/runhttps://api.uk1.datadoghq.com/api/v2/data-observability/monitors/{monitor_id}/runhttps://api.datadoghq.com/api/v2/data-observability/monitors/{monitor_id}/runhttps://api.us3.datadoghq.com/api/v2/data-observability/monitors/{monitor_id}/runhttps://api.us5.datadoghq.com/api/v2/data-observability/monitors/{monitor_id}/run
Overview
Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.
OAuth apps require the data_observability_monitors_write, monitors_write authorization scope to access this endpoint.
Arguments
Path Parameters
The ID of the data observability monitor to run.
Response
OK
The response returned when a data observability monitor run is triggered.
Expand All
The data object returned when a data observability monitor run is triggered.
The unique identifier of the monitor run.
The JSON:API resource type for a data observability monitor run.
Allowed enum values: monitor_run
default: monitor_run
{
"data": {
"id": "abc123def456",
"type": "monitor_run"
}
}
Bad Request
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}
Not Found
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}
Too many requests
{
"errors": [
"Bad Request"
]
}
Code Example
# Path parameters
export monitor_id="12345"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/data-observability/monitors/${monitor_id}/run" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
