---
title: "List deployment gate rule evaluations"
method: GET
path: "/api/v2/deployment_gates/evaluations/rules"
tags: ["Deployment Gates"]
---

# List deployment gate rule evaluations

`GET /api/v2/deployment_gates/evaluations/rules`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v2/deployment_gates/evaluations/rules`
- Auth: one of:
  - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`
  - OAuth 2
    - Authorization code: `/oauth2/v1/authorize`
    - Token URL: `/oauth2/v1/token` scopes: `deployment_gates_read`
- TypeScript: <https://skmtc.dev/datadog/apis/datadog-api-v2-collection/docs/api/v2/deployment_gates/evaluations/rules/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `filter[from]` string, date-time
- `filter[to]` string, date-time
- `filter[gate_evaluation_id]` string, uuid
- `filter[evaluation_id]` string, uuid
- `filter[gate_id]` string, uuid
- `filter[rule_id]` string, uuid
- `filter[service]` string[]
- `filter[env]` string[]
- `filter[identifier]` string[]
- `filter[version]` string[]
- `filter[status]` DeploymentGatesEvaluationResultResponseAttributesGateStatus[]
- `filter[type]` DeploymentGateRuleEvaluationType[]
- `filter[dry_run]` boolean
- `filter[gate_dry_run]` boolean
- `filter[name]` string[]
- `page[size]` integer
- `page[cursor]` string

## Response `200`

OK

- DeploymentGateRuleEvaluationsResponse: Paginated deployment gate rule evaluations.
  - `data` DeploymentGateRuleEvaluationData[], required
    - `attributes` DeploymentGateRuleEvaluationAttributes, required: Attributes of a deployment gate rule evaluation.
      - `configuration` DeploymentGateRuleEvaluationConfiguration, required: Evaluated rule configuration. Fields depend on rule type and unset fields are omitted. Monitor rules can include `duration`, `query`, `monitor_ids`, `warmup`, `fail_on_no_groups_found`, and `fail_on_no_data`. Faulty deployment detection rules can include `duration`, `allowed_resources`, and `excluded_resources`.
        - `allowed_resources` string[]: APM resources explicitly allowed by faulty deployment detection.
        - `duration` integer: Evaluation duration configured for this rule.
        - `excluded_resources` string[]: APM resources excluded from faulty deployment detection.
        - `fail_on_no_data` boolean: Whether a monitor rule fails when no data is found.
        - `fail_on_no_groups_found` boolean: Whether a monitor rule fails when no groups are found.
        - `monitor_ids` string[]: Monitor IDs evaluated by a monitor rule.
        - `query` string: Monitor query used by a monitor rule.
        - `warmup` integer: Warm-up duration in seconds for a monitor rule. Omitted when zero.
      - `dry_run` boolean, required: Whether this rule is non-enforcing. A failed dry-run rule is ignored when computing the gate outcome. Independent of `gate_dry_run`.
      - `duration_seconds` integer, nullable, required: Rule evaluation duration in seconds. Null while it is in progress.
      - `env` string, required: Evaluated environment.
      - `evaluation_id` string, uuid, required: Rule evaluation UUID. Matches the resource `id`.
      - `failures` DeploymentGateRuleFailures, required: Rule failure details.
        - `faulty_apm_resources` string[], required: Names of faulty APM resources.
        - `monitors` DeploymentGateRuleFailureMonitor[], required
          - `id` string, required: Monitor ID.
          - `state` string, required: Monitor state that caused the failure.
          - `url` string, required: URL for inspecting the monitor during the evaluation window.
        - `narratives` DeploymentGateRuleFailureNarrative[], required
          - `hostgroup` string, required: Host group associated with the narrative.
          - `id` string, required: Narrative ID.
      - `finished_at` string, date-time, nullable, required: Time the rule evaluation finished. Null while it is in progress.
      - `gate_dry_run` boolean, required: Whether the parent gate is dry-run. A failed dry-run gate blocks but does not stop deployment. Independent of rule-level `dry_run`.
      - `gate_evaluation_id` string, uuid, required: Deployment gate evaluation UUID.
      - `gate_id` string, uuid, nullable, required: Configured deployment gate UUID. Null for just-in-time evaluations.
      - `identifier` string, required: Deployment gate identifier.
      - `name` string, required: Rule name.
      - `reason` string, required: Reason for the rule result.
      - `rule_id` string, uuid, nullable, required: Configured deployment rule UUID. Null for just-in-time rules.
      - `service` string, required: Evaluated service.
      - `started_at` string, date-time, required: Time the rule evaluation started.
      - `status` 'in_progress' | 'pass' | 'fail', required: The recorded result of a gate or rule evaluation. - `in_progress`: The evaluation is still running. - `pass`: All rules passed successfully. - `fail`: One or more rules did not pass.
      - `type` 'monitor' | 'faulty_deployment_detection', required: Type of deployment gate rule.
      - `version` string, required: Evaluated deployment version. Empty when no version was provided.
    - `id` string, uuid, required: Rule evaluation UUID.
    - `type` 'deployment_gate_rule_evaluation', required: JSON:API type for a deployment gate rule evaluation.
  - `meta` DeploymentGateEvaluationListMeta, required: Pagination metadata.
    - `page` DeploymentGateEvaluationPage, required: Cursor pagination information.
      - `next_cursor` string: Opaque cursor for the next page. Absent on the final page.
      - `size` integer, required: Requested maximum number of resources in this page.

## Other responses

- `400`: Bad request.
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too many requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/3f70db624329?raw)