DAdatadog
Fleet Automation

Get a deployment by ID

Retrieve detailed information about a specific deployment, including its current status, configuration operations, and per-host execution status.

Returns a 404 if no deployment matches the given ID or if you do not have access to it.

get/api/v2/fleet/deployments/{deployment_id}

Request

Path parameters

deployment_idstring required

The unique identifier of the deployment to retrieve.

Response

OK

Example response

{
  "data": {
    "attributes": {
      "author": "carol@datadoghq.com",
      "canceled_hosts": 1,
      "config_operations": [
        {
          "file_op": "merge-patch",
          "file_path": "/datadog.yaml",
          "patch": {
            "apm_config": {
              "enabled": true
            },
            "log_level": "debug",
            "logs_enabled": true
          }
        }
      ],
      "duration_seconds": 3600,
      "error_summary": "A host failed to update",
      "estimated_finished_at": 1699999999,
      "failed_hosts": 1,
      "high_level_status": "running",
      "hosts": [
        {
          "hostname": "web-01.example.com",
          "running_step": "applying_config",
          "status": "running",
          "status_details": "step 2/3",
          "versions": [
            {
              "current_version": "7.51.0",
              "initial_version": "7.51.0",
              "package_name": "datadog-agent",
              "target_version": "7.52.0"
            }
          ]
        }
      ],
      "is_scheduled": true,
      "query": "env:prod AND service:web",
      "running_hosts": 1,
      "schedule_id": "sched-789",
      "skipped_hosts": 1,
      "succeeded_hosts": 1,
      "target_versions": [
        "7.52.0"
      ],
      "total_hosts": 42,
      "update_type": "update_config_operations"
    },
    "id": "k7Q-3mX-p9Z",
    "type": "deployment"
  }
}

Changes

Changes to this operation have not been checked yet.