DAdatadog
Deployment Gates

Trigger a deployment gate evaluation

Triggers an asynchronous deployment gate evaluation for the given service and environment. Returns an evaluation ID that can be used to poll for the result via the GET /api/v2/deployments/gates/evaluation/{id} endpoint.

When the configuration attribute is provided, rules are evaluated inline from that configuration and no pre-configured gate is required. When configuration is omitted, rules are resolved from the gate pre-configured for the given service and environment through the Datadog UI, API, or Terraform.

post/api/v2/deployments/gates/evaluation

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v2/deployments/gates/evaluation
  • Auth
    API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY

Request body

Example request

{
  "data": {
    "attributes": {
      "configuration": {
        "rules": [
          {
            "name": "error rate monitors",
            "options": {
              "duration": 300,
              "query": "service:transaction-backend env:production"
            },
            "type": "monitor"
          }
        ]
      },
      "env": "staging",
      "identifier": "pre-deploy",
      "primary_tag": "region:us-east-1",
      "service": "transaction-backend",
      "version": "v1.2.3"
    },
    "type": "deployment_gates_evaluation_request"
  }
}

Response

Accepted

Example response

{
  "data": {
    "attributes": {
      "evaluation_id": "e9d2f04f-4f4b-494b-86e5-52f03e10c8e9"
    },
    "id": "e9d2f04f-4f4b-494b-86e5-52f03e10c8e9",
    "type": "deployment_gates_evaluation_response"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.