Class FleetAutomationApi

Cancel an active deployment and stop all pending operations. When you cancel a deployment:

• All pending operations on hosts that haven't started yet are stopped
• Operations currently in progress on hosts may complete or be interrupted, depending on their current state
• Configuration changes or package upgrades already applied to hosts are not rolled back

After cancellation, you can view the final state of the deployment using the GET endpoint to see which hosts were successfully updated before the cancellation.

Create a new deployment to apply configuration changes to a fleet of hosts matching the specified filter query.

This endpoint supports two types of configuration operations:

• merge-patch: Merges the provided patch data with the existing configuration file, creating the file if it doesn't exist
• delete: Removes the specified configuration file from the target hosts

The deployment is created and started automatically. You can specify multiple configuration operations that will be executed in order on each target host. Use the filter query to target specific hosts using the Datadog query syntax.

Create and immediately start a new package upgrade on hosts matching the specified filter query.

This endpoint allows you to upgrade the Datadog Agent to a specific version on hosts matching the specified filter query.

The deployment is created and started automatically. The system will:

1. Identify all hosts matching the filter query
2. Validate that the specified version is available
3. Begin rolling out the package upgrade to the target hosts

Create a new schedule for automated package upgrades.

Schedules define when and how often to automatically deploy package upgrades to a fleet of hosts. Each schedule includes:

• A filter query to select target hosts
• A recurrence rule defining maintenance windows
• A version strategy (e.g., always latest, or N versions behind latest)

When the schedule triggers during a maintenance window, it automatically creates a deployment that upgrades the Datadog Agent to the specified version on all matching hosts.

Delete a schedule permanently.

When you delete a schedule:

• The schedule is permanently removed and will no longer create deployments
• Any deployments already created by this schedule are not affected
• This action cannot be undone

If you want to temporarily stop a schedule from creating deployments, consider updating its status to "inactive" instead of deleting it.

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.

Retrieve detailed information about a specific schedule using its unique identifier.

This endpoint returns comprehensive information about a schedule, including:

• Schedule metadata (ID, name, creation/update timestamps)
• Filter query for selecting target hosts
• Recurrence rule defining when deployments are triggered
• Version strategy for package upgrades
• Current status (active or inactive)

Retrieve a list of all available Datadog Agent versions.

This endpoint returns the available Agent versions that can be deployed to your fleet. These versions are used when creating deployments or configuring schedules for automated Agent upgrades.

Retrieve a list of all deployments for fleet automation. Use the page_size and page_offset parameters to paginate results.

Retrieve a list of all schedules for automated fleet deployments.

Schedules allow you to automate package upgrades by defining maintenance windows and recurrence rules. Each schedule automatically creates deployments based on its configuration.

Manually trigger a schedule to immediately create and start a deployment.

This endpoint allows you to manually initiate a deployment using the schedule's configuration, without waiting for the next scheduled maintenance window. This is useful for:

• Testing a schedule before it runs automatically
• Performing an emergency update outside the regular maintenance window
• Creating an ad-hoc deployment with the same settings as a schedule

The deployment is created immediately with:

• The same filter query as the schedule
• The package version determined by the schedule's version strategy
• All matching hosts as targets

The manually triggered deployment is independent of the schedule and does not affect the schedule's normal recurrence pattern.

Partially update a schedule by providing only the fields you want to change.

This endpoint allows you to modify specific attributes of a schedule without affecting other fields. Common use cases include:

• Changing the schedule status between active and inactive
• Updating the maintenance window times
• Modifying the filter query to target different hosts
• Adjusting the version strategy

Only include the fields you want to update in the request body. All fields are optional in a PATCH request.