provider Fleet Automation GET /api/unstable/fleet/deployments/{deployment_id}
@utdk/datadog /api/unstable/fleet/deployments/{deployment_id}
Get a configuration deployment by ID
Retrieve detailed information about a specific deployment using its unique identifier. This endpoint returns comprehensive information about a deployment, including: - Deployment metadata (ID, type, filter query) - Total number of target hosts - Current high-level status (pending, running, succeeded, failed) - Estimated completion time - Configuration operations that were or are being applied - Detailed host list: A paginated array of hosts included in this deployment with individual host status, current package versions, and any errors The host list provides visibility into the per-host execution status, allowing you to: - Monitor which hosts have completed successfully - Identify hosts that are still in progress - Investigate failures on specific hosts - View current package versions installed on each host (including initial, target, and current versions for each package) Pagination: Use the `limit` and `page` query parameters to paginate through hosts. The response includes pagination metadata in the `meta.hosts` field with information about the current page, total pages, and total host count. The default page size is 50 hosts, with a maximum of 100.
deployment_id path required
The unique identifier of the deployment to retrieve.
string
limit query
Maximum number of hosts to return per page. Default is 50, maximum is 100.
integer
page query
Page index for pagination (zero-based). Use this to retrieve subsequent pages of hosts.
integer

Try it

Authentication
Configure credentials for Datadog API V2 Collection
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getfleetdeployment
GET/api/unstable/fleet/deployments/{deployment_id}
Retrieve detailed information about a specific deployment using its unique identifier. This endpoint returns comprehensive information about a deployment, including: - Deployment metadata (ID, type, filter query) - Total number of target hosts - Current high-level status (pending, running, succeeded, failed) - Estimated completion time - Configuration operations that were or are being applied - Detailed host list: A paginated array of hosts included in this deployment with individual host status, current package versions, and any errors The host list provides visibility into the per-host execution status, allowing you to: - Monitor which hosts have completed successfully - Identify hosts that are still in progress - Investigate failures on specific hosts - View current package versions installed on each host (including initial, target, and current versions for each package) Pagination: Use the `limit` and `page` query parameters to paginate through hosts. The response includes pagination metadata in the `meta.hosts` field with information about the current page, total pages, and total host count. The default page size is 50 hosts, with a maximum of 100.

Parameters

required

The unique identifier of the deployment to retrieve.

Maximum number of hosts to return per page. Default is 50, maximum is 100.

Page index for pagination (zero-based). Use this to retrieve subsequent pages of hosts.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import datadog from '@utdk/datadog';

await datadog.getfleetdeployment({
  "limit": 50,
  "page": 0
})