DAdatadog
Fleet Automation

List all deployments

Retrieve a paginated list of all deployments for fleet automation.

get/api/v2/fleet/deployments

Request

Query parameters

page_sizeinteger

Number of deployments to return per page. Maximum value is 100.

page_numberinteger

Page number for pagination, starting at 0.

sortstring

Field to sort results by (for example, start_date). Must be a supported field name; unsupported values return a 400 error.

ascendingboolean

Set to true to sort in ascending order. This setting has no effect unless sort is also set. Defaults to descending order.

filterstring

Query used to filter deployments. Uses the Datadog query syntax. Filtering on an unsupported field returns a 400 error. For example:

  • status:failed or status:done_with_errors: deployments that need investigation.
  • status:running: deployments currently in flight.
  • update_type:update_package or update_type:update_config_operations: deployments of a given type.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "author": "alice@datadoghq.com",
        "config_operations": [
          {
            "file_op": "merge-patch",
            "file_path": "/datadog.yaml",
            "patch": {
              "apm_config": {
                "enabled": true
              },
              "log_level": "debug",
              "logs_enabled": true
            }
          }
        ],
        "duration_seconds": 1000,
        "error_summary": "A host failed to update",
        "estimated_finished_at": 1699999999,
        "is_scheduled": true,
        "query": "env:prod AND service:web",
        "schedule_id": "sched-123",
        "started_at": 1699990000,
        "status": "pending",
        "target_versions": [
          "7.52.0"
        ],
        "total_hosts": 42,
        "update_type": "update_config_operations"
      },
      "id": "k7Q-3mX-p9Z",
      "type": "deployment"
    }
  ],
  "meta": {
    "page": {
      "total_count": 25,
      "total_filtered_count": 10
    }
  }
}

Changes

Changes to this operation have not been checked yet.