@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.GetFleetAgentDetailV2OptionalParameters
Manage optional parameters to getFleetAgentDetailV2.
|
static class |
FleetAutomationApi.ListFleetAgentsV2OptionalParameters
Manage optional parameters to listFleetAgentsV2.
|
static class |
FleetAutomationApi.ListFleetAgentTracersOptionalParameters
Manage optional parameters to listFleetAgentTracers.
|
static class |
FleetAutomationApi.ListFleetDeploymentsV2OptionalParameters
Manage optional parameters to listFleetDeploymentsV2.
|
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 FleetDeploymentV2CancelResponse cancelFleetDeploymentV2(String deploymentId) throws ApiException
deploymentId - The unique identifier of the deployment to cancel. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentV2CancelResponse> cancelFleetDeploymentV2Async(String deploymentId)
See cancelFleetDeploymentV2WithHttpInfoAsync(java.lang.String).
deploymentId - The unique identifier of the deployment to cancel. (required)public ApiResponse<FleetDeploymentV2CancelResponse> cancelFleetDeploymentV2WithHttpInfo(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.
Only deployments with a pending or running status can be canceled.
Returns a 400 if the deployment is not in a cancelable status. Returns a 404 if no deployment
matches the specified ID or if you do not have access to it.
deploymentId - The unique identifier of the deployment to cancel. (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<FleetDeploymentV2CancelResponse>> cancelFleetDeploymentV2WithHttpInfoAsync(String deploymentId)
deploymentId - The unique identifier of the deployment to cancel. (required)public FleetDeploymentConfigureV2DryRunResponse createFleetDeploymentConfigureV2(FleetDeploymentConfigureV2CreateRequest body) throws ApiException
body - Request payload containing the deployment details. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentConfigureV2DryRunResponse> createFleetDeploymentConfigureV2Async(FleetDeploymentConfigureV2CreateRequest body)
body - Request payload containing the deployment details. (required)public ApiResponse<FleetDeploymentConfigureV2DryRunResponse> createFleetDeploymentConfigureV2WithHttpInfo(FleetDeploymentConfigureV2CreateRequest 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.
You can optionally use target_packages to apply the configuration change only
to specific package versions.
The deployment is created and started automatically. You can specify multiple configuration operations to execute in order on each target host. Use the filter query to target specific hosts using the Datadog query syntax.
Set dry_run to true to validate the configuration and resolve
target hosts and packages without deploying anything. A dry run returns a 200 with the
validation result instead of creating and starting a deployment.
Returns a 400 if filter_query or config_operations is missing, a
target package is missing a name or version or cannot be resolved, the configuration fails
validation, or the filter query does not match any host eligible for the deployment.
body - Request payload containing the deployment details. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | CREATED | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetDeploymentConfigureV2DryRunResponse>> createFleetDeploymentConfigureV2WithHttpInfoAsync(FleetDeploymentConfigureV2CreateRequest body)
body - Request payload containing the deployment details. (required)public FleetDeploymentV2CreateResponse createFleetDeploymentUpgradeV2(FleetDeploymentPackageUpgradeV2CreateRequest body) throws ApiException
body - Request payload containing the package upgrade details. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentV2CreateResponse> createFleetDeploymentUpgradeV2Async(FleetDeploymentPackageUpgradeV2CreateRequest body)
body - Request payload containing the package upgrade details. (required)public ApiResponse<FleetDeploymentV2CreateResponse> createFleetDeploymentUpgradeV2WithHttpInfo(FleetDeploymentPackageUpgradeV2CreateRequest 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: 1. Identifies all hosts matching the filter query. 2. Validates that the specified version is available. 3. Begins rolling out the package upgrade to the target hosts.
Returns a 400 if filter_query or target_packages is missing, a
target package is missing a name or version, or the filter query does not match any host
eligible for the upgrade. Returns a 409 if a conflicting upgrade is already running on one or
more 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 | - |
| 409 | Conflict | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetDeploymentV2CreateResponse>> createFleetDeploymentUpgradeV2WithHttpInfoAsync(FleetDeploymentPackageUpgradeV2CreateRequest 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 FleetAgentDetailV2Response getFleetAgentDetailV2(String agentKey) throws ApiException
agentKey - The unique identifier (Agent key) for the Datadog Agent. Must be a 32-character
lowercase hexadecimal string. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetAgentDetailV2Response> getFleetAgentDetailV2Async(String agentKey)
agentKey - The unique identifier (Agent key) for the Datadog Agent. Must be a 32-character
lowercase hexadecimal string. (required)public FleetAgentDetailV2Response getFleetAgentDetailV2(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters) throws ApiException
agentKey - The unique identifier (Agent key) for the Datadog Agent. Must be a 32-character
lowercase hexadecimal string. (required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<FleetAgentDetailV2Response> getFleetAgentDetailV2Async(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters)
agentKey - The unique identifier (Agent key) for the Datadog Agent. Must be a 32-character
lowercase hexadecimal string. (required)parameters - Optional parameters for the request.public ApiResponse<FleetAgentDetailV2Response> getFleetAgentDetailV2WithHttpInfo(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters) throws ApiException
By default, only agent_infos is returned. Use the include query
parameter to request additional data: integrations and/or
configuration_files.
agentKey - The unique identifier (Agent key) for the Datadog Agent. Must be a 32-character
lowercase hexadecimal string. (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<FleetAgentDetailV2Response>> getFleetAgentDetailV2WithHttpInfoAsync(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters)
agentKey - The unique identifier (Agent key) for the Datadog Agent. Must be a 32-character
lowercase hexadecimal string. (required)parameters - Optional parameters for the request.public FleetDeploymentV2DetailResponse getFleetDeploymentV2(String deploymentId) throws ApiException
deploymentId - The unique identifier of the deployment to retrieve. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentV2DetailResponse> getFleetDeploymentV2Async(String deploymentId)
See getFleetDeploymentV2WithHttpInfoAsync(java.lang.String).
deploymentId - The unique identifier of the deployment to retrieve. (required)public ApiResponse<FleetDeploymentV2DetailResponse> getFleetDeploymentV2WithHttpInfo(String deploymentId) throws ApiException
Returns a 404 if no deployment matches the given ID or if you do not have access to it.
deploymentId - The unique identifier of the deployment 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<FleetDeploymentV2DetailResponse>> getFleetDeploymentV2WithHttpInfoAsync(String deploymentId)
deploymentId - The unique identifier of the deployment to retrieve. (required)public FleetScheduleV2Response getFleetScheduleV2(String id) throws ApiException
id - The unique identifier of the schedule to retrieve. (required)ApiException - if fails to make API callpublic CompletableFuture<FleetScheduleV2Response> getFleetScheduleV2Async(String id)
id - The unique identifier of the schedule to retrieve. (required)public ApiResponse<FleetScheduleV2Response> getFleetScheduleV2WithHttpInfo(String id) throws ApiException
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<FleetScheduleV2Response>> getFleetScheduleV2WithHttpInfoAsync(String id)
id - The unique identifier of the schedule to retrieve. (required)public FleetAgentsV2Response listFleetAgentsV2() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<FleetAgentsV2Response> listFleetAgentsV2Async()
public FleetAgentsV2Response listFleetAgentsV2(FleetAutomationApi.ListFleetAgentsV2OptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<FleetAgentsV2Response> listFleetAgentsV2Async(FleetAutomationApi.ListFleetAgentsV2OptionalParameters parameters)
parameters - Optional parameters for the request.public ApiResponse<FleetAgentsV2Response> listFleetAgentsV2WithHttpInfo(FleetAutomationApi.ListFleetAgentsV2OptionalParameters parameters) throws ApiException
Returns agents with support for pagination, sorting, and filtering. Use page_number
and page_size to navigate pages, filter to narrow by field
values, and tags to filter by agent tags.
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<FleetAgentsV2Response>> listFleetAgentsV2WithHttpInfoAsync(FleetAutomationApi.ListFleetAgentsV2OptionalParameters 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 FleetAgentVersionsV2Response listFleetAgentVersionsV2() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<FleetAgentVersionsV2Response> listFleetAgentVersionsV2Async()
public ApiResponse<FleetAgentVersionsV2Response> listFleetAgentVersionsV2WithHttpInfo() throws ApiException
Returns 200 with an empty data array if the Agent package exists
in the catalog but has no available versions, and 404 only if the Agent package
itself is absent from the catalog.
ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<FleetAgentVersionsV2Response>> listFleetAgentVersionsV2WithHttpInfoAsync()
public FleetDeploymentsV2Response listFleetDeploymentsV2() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentsV2Response> listFleetDeploymentsV2Async()
public FleetDeploymentsV2Response listFleetDeploymentsV2(FleetAutomationApi.ListFleetDeploymentsV2OptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<FleetDeploymentsV2Response> listFleetDeploymentsV2Async(FleetAutomationApi.ListFleetDeploymentsV2OptionalParameters parameters)
parameters - Optional parameters for the request.public ApiResponse<FleetDeploymentsV2Response> listFleetDeploymentsV2WithHttpInfo(FleetAutomationApi.ListFleetDeploymentsV2OptionalParameters parameters) throws ApiException
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<FleetDeploymentsV2Response>> listFleetDeploymentsV2WithHttpInfoAsync(FleetAutomationApi.ListFleetDeploymentsV2OptionalParameters parameters)
parameters - Optional parameters for the request.public FleetSchedulesV2Response listFleetSchedulesV2() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<FleetSchedulesV2Response> listFleetSchedulesV2Async()
public ApiResponse<FleetSchedulesV2Response> listFleetSchedulesV2WithHttpInfo() throws ApiException
Schedules 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<FleetSchedulesV2Response>> listFleetSchedulesV2WithHttpInfoAsync()
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.