For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/ja/api/latest/deployment-gates/list-deployment-gate-rule-evaluations.md. A documentation index is available at /llms.txt.
homeホームdocsドキュメントapiAPI
Language
Datadog site

List deployment gate rule evaluations

警告Note: This endpoint is in preview and may be subject to change. If you have any feedback, contact Datadog support.
GEThttps://api.datadoghq.com/api/v2/deployment_gates/evaluations/ruleshttps://api.us3.datadoghq.com/api/v2/deployment_gates/evaluations/ruleshttps://api.us5.datadoghq.com/api/v2/deployment_gates/evaluations/ruleshttps://api.datadoghq.eu/api/v2/deployment_gates/evaluations/ruleshttps://api.ap1.datadoghq.com/api/v2/deployment_gates/evaluations/ruleshttps://api.ap2.datadoghq.com/api/v2/deployment_gates/evaluations/ruleshttps://api.uk1.datadoghq.com/api/v2/deployment_gates/evaluations/ruleshttps://api.ddog-gov.com/api/v2/deployment_gates/evaluations/ruleshttps://api.us2.ddog-gov.com/api/v2/deployment_gates/evaluations/rules

概要

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.

This endpoint requires the deployment_gates_read permission.

OAuth apps require the deployment_gates_read authorization scope to access this endpoint.

引数

クエリ文字列

名前
タイプ
説明
filter[from]
string

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.

filter[to]
string

Exclusive gate evaluation start time. Defaults to the request time. Must be after filter[from]; the window may span no more than 30 days.

filter[gate_evaluation_id]
string

Gate evaluation UUID. No match returns an empty list.

filter[evaluation_id]
string

Rule evaluation UUID. No match returns an empty list.

filter[gate_id]
string

Configured gate UUID. Just-in-time evaluations have no gate ID.

filter[rule_id]
string

Configured rule UUID. Just-in-time rules have no rule ID.

filter[service]
array

Evaluated service values. Repeated or comma-separated values are combined with OR.

filter[env]
array

Evaluated environment values. Repeated or comma-separated values are combined with OR.

filter[identifier]
array

Gate identifier values. Repeated or comma-separated values are combined with OR.

filter[version]
array

Evaluated deployment version values. Repeated or comma-separated values are combined with OR.

filter[status]
array

Rule statuses. Repeated or comma-separated values are combined with OR.

filter[type]
array

Rule types. Repeated or comma-separated values are combined with OR. Defaults to all rule types.

filter[dry_run]
boolean

Rule-level dry-run state. A failed dry-run rule is ignored when computing the gate outcome.

filter[gate_dry_run]
boolean

Gate-level dry-run state. A failed dry-run gate blocks but does not stop deployment.

filter[name]
array

Rule names. Repeated or comma-separated values are combined with OR.

page[size]
integer

Maximum rule evaluations returned.

Default: 50
page[cursor]
string

Opaque cursor returned in meta.page.next_cursor by the previous page. Invalid cursors return 400.

応答

OK

Paginated deployment gate rule evaluations.

フィールド
タイプ
説明
data [required]
[object]
meta [required]
object

Pagination metadata.

コード例

List deployment gate rule evaluations
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/deployment_gates/evaluations/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/deployment_gates/evaluations/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/deployment_gates/evaluations/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/deployment_gates/evaluations/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/deployment_gates/evaluations/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/deployment_gates/evaluations/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/deployment_gates/evaluations/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/deployment_gates/evaluations/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/deployment_gates/evaluations/rules" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"