@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") public class FleetAutomationApi extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
FleetAutomationApi.GetFleetDeploymentOptionalParameters
Manage optional parameters to getFleetDeployment.
|
static class |
FleetAutomationApi.ListFleetAgentsOptionalParameters
Manage optional parameters to listFleetAgents.
|
static class |
FleetAutomationApi.ListFleetAgentTracersOptionalParameters
Manage optional parameters to listFleetAgentTracers.
|
static class |
FleetAutomationApi.ListFleetDeploymentsOptionalParameters
Manage optional parameters to listFleetDeployments.
|
static class |
FleetAutomationApi.ListFleetTracersOptionalParameters
Manage optional parameters to listFleetTracers.
|
| Constructor and Description |
|---|
FleetAutomationApi() |
FleetAutomationApi(ApiClient apiClient) |
public FleetAutomationApi()
public FleetAutomationApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
apiClient - an instance of API clientpublic void cancelFleetDeployment(String deploymentId) throws ApiException
deploymentId - The unique identifier of the deployment to cancel. (required)ApiException - if fails to make API callpublic CompletableFuture<Void> cancelFleetDeploymentAsync(String deploymentId)
See cancelFleetDeploymentWithHttpInfoAsync(java.lang.String).
deploymentId - The unique identifier of the deployment to cancel. (required)public ApiResponse<Void> cancelFleetDeploymentWithHttpInfo(String deploymentId) throws ApiException
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.
deploymentId - The unique identifier of the deployment to cancel. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 204 | Deployment successfully canceled. | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<Void>> cancelFleetDeploymentWithHttpInfoAsync(String deploymentId)
deploymentId - The unique identifier of the deployment to cancel. (required)public FleetDeploymentResponse createFleetDeploymentConfigure(FleetDeploymentConfigureCreateRequest body) throws ApiException
body - Request payload containing the deployment details. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentResponse> createFleetDeploymentConfigureAsync(FleetDeploymentConfigureCreateRequest body)
body - Request payload containing the deployment details. (required)public ApiResponse<FleetDeploymentResponse> createFleetDeploymentConfigureWithHttpInfo(FleetDeploymentConfigureCreateRequest body) throws ApiException
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.
body - Request payload containing the deployment details. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 201 | CREATED | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetDeploymentResponse>> createFleetDeploymentConfigureWithHttpInfoAsync(FleetDeploymentConfigureCreateRequest body)
body - Request payload containing the deployment details. (required)public FleetDeploymentResponse createFleetDeploymentUpgrade(FleetDeploymentPackageUpgradeCreateRequest body) throws ApiException
body - Request payload containing the package upgrade details. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentResponse> createFleetDeploymentUpgradeAsync(FleetDeploymentPackageUpgradeCreateRequest body)
body - Request payload containing the package upgrade details. (required)public ApiResponse<FleetDeploymentResponse> createFleetDeploymentUpgradeWithHttpInfo(FleetDeploymentPackageUpgradeCreateRequest body) throws ApiException
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
body - Request payload containing the package upgrade details. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 201 | CREATED | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetDeploymentResponse>> createFleetDeploymentUpgradeWithHttpInfoAsync(FleetDeploymentPackageUpgradeCreateRequest body)
body - Request payload containing the package upgrade details. (required)public FleetScheduleResponse createFleetSchedule(FleetScheduleCreateRequest body) throws ApiException
See createFleetScheduleWithHttpInfo(com.datadog.api.client.v2.model.FleetScheduleCreateRequest).
body - Request payload containing the schedule details. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetScheduleResponse> createFleetScheduleAsync(FleetScheduleCreateRequest body)
See createFleetScheduleWithHttpInfoAsync(com.datadog.api.client.v2.model.FleetScheduleCreateRequest).
body - Request payload containing the schedule details. (required)public ApiResponse<FleetScheduleResponse> createFleetScheduleWithHttpInfo(FleetScheduleCreateRequest body) throws ApiException
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.
body - Request payload containing the schedule details. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 201 | CREATED | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetScheduleResponse>> createFleetScheduleWithHttpInfoAsync(FleetScheduleCreateRequest body)
See createFleetScheduleWithHttpInfo(com.datadog.api.client.v2.model.FleetScheduleCreateRequest).
body - Request payload containing the schedule details. (required)public void deleteFleetSchedule(String id) throws ApiException
id - The unique identifier of the schedule to delete. (required)ApiException - if fails to make API callpublic CompletableFuture<Void> deleteFleetScheduleAsync(String id)
id - The unique identifier of the schedule to delete. (required)public ApiResponse<Void> deleteFleetScheduleWithHttpInfo(String id) throws ApiException
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.
id - The unique identifier of the schedule to delete. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 204 | Schedule successfully deleted. | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<Void>> deleteFleetScheduleWithHttpInfoAsync(String id)
id - The unique identifier of the schedule to delete. (required)public FleetAgentInfoResponse getFleetAgentInfo(String agentKey) throws ApiException
agentKey - The unique identifier (agent key) for the Datadog Agent. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetAgentInfoResponse> getFleetAgentInfoAsync(String agentKey)
agentKey - The unique identifier (agent key) for the Datadog Agent. (required)public ApiResponse<FleetAgentInfoResponse> getFleetAgentInfoWithHttpInfo(String agentKey) throws ApiException
agentKey - The unique identifier (agent key) for the Datadog Agent. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetAgentInfoResponse>> getFleetAgentInfoWithHttpInfoAsync(String agentKey)
agentKey - The unique identifier (agent key) for the Datadog Agent. (required)public FleetDeploymentResponse getFleetDeployment(String deploymentId) throws ApiException
deploymentId - The unique identifier of the deployment to retrieve. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentResponse> getFleetDeploymentAsync(String deploymentId)
deploymentId - The unique identifier of the deployment to retrieve. (required)public FleetDeploymentResponse getFleetDeployment(String deploymentId, FleetAutomationApi.GetFleetDeploymentOptionalParameters parameters) throws ApiException
deploymentId - The unique identifier of the deployment to retrieve. (required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentResponse> getFleetDeploymentAsync(String deploymentId, FleetAutomationApi.GetFleetDeploymentOptionalParameters parameters)
deploymentId - The unique identifier of the deployment to retrieve. (required)parameters - Optional parameters for the request.public ApiResponse<FleetDeploymentResponse> getFleetDeploymentWithHttpInfo(String deploymentId, FleetAutomationApi.GetFleetDeploymentOptionalParameters parameters) throws ApiException
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.
deploymentId - The unique identifier of the deployment to retrieve. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetDeploymentResponse>> getFleetDeploymentWithHttpInfoAsync(String deploymentId, FleetAutomationApi.GetFleetDeploymentOptionalParameters parameters)
deploymentId - The unique identifier of the deployment to retrieve. (required)parameters - Optional parameters for the request.public FleetScheduleResponse getFleetSchedule(String id) throws ApiException
id - The unique identifier of the schedule to retrieve. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetScheduleResponse> getFleetScheduleAsync(String id)
id - The unique identifier of the schedule to retrieve. (required)public ApiResponse<FleetScheduleResponse> getFleetScheduleWithHttpInfo(String id) throws ApiException
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)
id - The unique identifier of the schedule to retrieve. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetScheduleResponse>> getFleetScheduleWithHttpInfoAsync(String id)
id - The unique identifier of the schedule to retrieve. (required)public FleetAgentsResponse listFleetAgents() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<FleetAgentsResponse> listFleetAgentsAsync()
public FleetAgentsResponse listFleetAgents(FleetAutomationApi.ListFleetAgentsOptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<FleetAgentsResponse> listFleetAgentsAsync(FleetAutomationApi.ListFleetAgentsOptionalParameters parameters)
parameters - Optional parameters for the request.public ApiResponse<FleetAgentsResponse> listFleetAgentsWithHttpInfo(FleetAutomationApi.ListFleetAgentsOptionalParameters parameters) throws ApiException
page_number
and page_size query parameters to paginate through results.parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetAgentsResponse>> listFleetAgentsWithHttpInfoAsync(FleetAutomationApi.ListFleetAgentsOptionalParameters parameters)
parameters - Optional parameters for the request.public FleetTracersResponse listFleetAgentTracers(String agentKey) throws ApiException
agentKey - The unique identifier (agent key) for the Datadog Agent. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetTracersResponse> listFleetAgentTracersAsync(String agentKey)
agentKey - The unique identifier (agent key) for the Datadog Agent. (required)public FleetTracersResponse listFleetAgentTracers(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters) throws ApiException
agentKey - The unique identifier (agent key) for the Datadog Agent. (required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<FleetTracersResponse> listFleetAgentTracersAsync(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters)
agentKey - The unique identifier (agent key) for the Datadog Agent. (required)parameters - Optional parameters for the request.public ApiResponse<FleetTracersResponse> listFleetAgentTracersWithHttpInfo(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters) throws ApiException
This endpoint returns tracers associated with a given agent key, identified by the agent's hostname. Use this to discover telemetry-derived service names for a particular host.
agentKey - The unique identifier (agent key) for the Datadog Agent. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetTracersResponse>> listFleetAgentTracersWithHttpInfoAsync(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters)
agentKey - The unique identifier (agent key) for the Datadog Agent. (required)parameters - Optional parameters for the request.public FleetAgentVersionsResponse listFleetAgentVersions() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<FleetAgentVersionsResponse> listFleetAgentVersionsAsync()
public ApiResponse<FleetAgentVersionsResponse> listFleetAgentVersionsWithHttpInfo() throws ApiException
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.
ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetAgentVersionsResponse>> listFleetAgentVersionsWithHttpInfoAsync()
public FleetDeploymentsResponse listFleetDeployments() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentsResponse> listFleetDeploymentsAsync()
public FleetDeploymentsResponse listFleetDeployments(FleetAutomationApi.ListFleetDeploymentsOptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentsResponse> listFleetDeploymentsAsync(FleetAutomationApi.ListFleetDeploymentsOptionalParameters parameters)
parameters - Optional parameters for the request.public ApiResponse<FleetDeploymentsResponse> listFleetDeploymentsWithHttpInfo(FleetAutomationApi.ListFleetDeploymentsOptionalParameters parameters) throws ApiException
page_size and
page_offset parameters to paginate results.parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetDeploymentsResponse>> listFleetDeploymentsWithHttpInfoAsync(FleetAutomationApi.ListFleetDeploymentsOptionalParameters parameters)
parameters - Optional parameters for the request.public FleetSchedulesResponse listFleetSchedules() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<FleetSchedulesResponse> listFleetSchedulesAsync()
public ApiResponse<FleetSchedulesResponse> listFleetSchedulesWithHttpInfo() throws ApiException
Schedules allow you to automate package upgrades by defining maintenance windows and recurrence rules. Each schedule automatically creates deployments based on its configuration.
ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetSchedulesResponse>> listFleetSchedulesWithHttpInfoAsync()
public FleetTracersResponse listFleetTracers() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<FleetTracersResponse> listFleetTracersAsync()
public FleetTracersResponse listFleetTracers(FleetAutomationApi.ListFleetTracersOptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<FleetTracersResponse> listFleetTracersAsync(FleetAutomationApi.ListFleetTracersOptionalParameters parameters)
parameters - Optional parameters for the request.public ApiResponse<FleetTracersResponse> listFleetTracersWithHttpInfo(FleetAutomationApi.ListFleetTracersOptionalParameters parameters) throws ApiException
This endpoint returns telemetry-derived service names from the SDK telemetry pipeline. These
names may differ from span-derived names in APM and are useful for querying service library
configurations. Use the page_number and page_size query parameters to
paginate through results.
parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetTracersResponse>> listFleetTracersWithHttpInfoAsync(FleetAutomationApi.ListFleetTracersOptionalParameters parameters)
parameters - Optional parameters for the request.public FleetDeploymentResponse triggerFleetSchedule(String id) throws ApiException
id - The unique identifier of the schedule to trigger. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentResponse> triggerFleetScheduleAsync(String id)
See triggerFleetScheduleWithHttpInfoAsync(java.lang.String).
id - The unique identifier of the schedule to trigger. (required)public ApiResponse<FleetDeploymentResponse> triggerFleetScheduleWithHttpInfo(String id) throws ApiException
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.
id - The unique identifier of the schedule to trigger. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 201 | CREATED - Deployment successfully created and started. | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetDeploymentResponse>> triggerFleetScheduleWithHttpInfoAsync(String id)
id - The unique identifier of the schedule to trigger. (required)public FleetScheduleResponse updateFleetSchedule(String id, FleetSchedulePatchRequest body) throws ApiException
id - The unique identifier of the schedule to update. (required)body - Request payload containing the fields to update. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetScheduleResponse> updateFleetScheduleAsync(String id, FleetSchedulePatchRequest body)
id - The unique identifier of the schedule to update. (required)body - Request payload containing the fields to update. (required)public ApiResponse<FleetScheduleResponse> updateFleetScheduleWithHttpInfo(String id, FleetSchedulePatchRequest body) throws ApiException
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.
id - The unique identifier of the schedule to update. (required)body - Request payload containing the fields to update. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetScheduleResponse>> updateFleetScheduleWithHttpInfoAsync(String id, FleetSchedulePatchRequest body)
id - The unique identifier of the schedule to update. (required)body - Request payload containing the fields to update. (required)Copyright © 2026. All rights reserved.