List deployment gate rule evaluations
Returns rule evaluations whose gate evaluation started in a maximum 30-day window (the default is the previous 24 hours). Filter by gate, rule, gate evaluation, or rule evaluation ID; omit IDs for cross-evaluation searches. Results are ordered by start time, newest first. In-progress state is near-real-time and mutable. Finished state is eventually consistent. Gate-level and rule-level dry-run states are independent. Pagination is deterministic but not snapshot isolated; clients should deduplicate by rule evaluation ID.
Request
- Base URLhttps://api.datadoghq.com
- Auth
- API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
- or OAuth 2Authorization code/oauth2/v1/authorizeToken URL/oauth2/v1/tokenScopesdeployment_gates_read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Inclusive gate evaluation start time. Defaults to 24 hours before the request. Together with filter[to], the window may span no more than 30 days.
Exclusive gate evaluation start time. Defaults to the request time. Must be after filter[from]; the window may span no more than 30 days.
Gate evaluation UUID. No match returns an empty list.
Rule evaluation UUID. No match returns an empty list.
Configured gate UUID. Just-in-time evaluations have no gate ID.
Configured rule UUID. Just-in-time rules have no rule ID.
Evaluated service values. Repeated or comma-separated values are combined with OR.
Evaluated environment values. Repeated or comma-separated values are combined with OR.
Gate identifier values. Repeated or comma-separated values are combined with OR.
Evaluated deployment version values. Repeated or comma-separated values are combined with OR.
Rule statuses. Repeated or comma-separated values are combined with OR.
[ "pass" ]
Rule types. Repeated or comma-separated values are combined with OR. Defaults to all rule types.
[ "faulty_deployment_detection" ]
Rule-level dry-run state. A failed dry-run rule is ignored when computing the gate outcome.
Gate-level dry-run state. A failed dry-run gate blocks but does not stop deployment.
Rule names. Repeated or comma-separated values are combined with OR.
Maximum rule evaluations returned.
Opaque cursor returned in meta.page.next_cursor by the previous page. Invalid cursors return 400.
Response
OK
Example response
{
"data": [
{
"attributes": {
"env": "prod",
"evaluation_id": "4f66c1c6-8346-59e5-be44-238214133260",
"failures": {
"faulty_apm_resources": [
"GET /checkout"
],
"monitors": [
{
"id": "12345678",
"state": "alert",
"url": "https://app.datadoghq.com/monitors/12345678"
}
],
"narratives": [
{
"hostgroup": "service:checkout,env:prod",
"id": "narrative-123"
}
]
},
"finished_at": "2026-09-14T08:15:00Z",
"gate_evaluation_id": "426a8f7b-b3e8-45f9-9d99-a1ed2f7fea04",
"gate_id": "e7cd2af1-b67b-11ee-8d0d-2a7caf4aa214",
"identifier": "default",
"name": "APM faulty deployment detection",
"reason": "A faulty resource was detected.",
"rule_id": "5cb4e76f-2937-47d7-80c8-7255ce2b76a4",
"service": "checkout",
"started_at": "2026-09-14T08:00:00Z",
"status": "pass",
"type": "faulty_deployment_detection",
"version": "2026.09.14.1"
},
"id": "4f66c1c6-8346-59e5-be44-238214133260",
"type": "deployment_gate_rule_evaluation"
}
],
"meta": {
"page": {
"size": 1
}
}
}Changes
Changes to this operation have not been checked yet.