Class FleetAutomationApi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classManage optional parameters to getFleetAgentDetailV2.static classManage optional parameters to listFleetAgentsV2.static classManage optional parameters to listFleetAgentTracers.static classManage optional parameters to listFleetDeploymentsV2.static classManage optional parameters to listFleetTracers. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncancelFleetDeploymentV2(String deploymentId) Cancel a deployment.cancelFleetDeploymentV2Async(String deploymentId) Cancel a deployment.cancelFleetDeploymentV2WithHttpInfo(String deploymentId) Cancel an active deployment and stop all pending operations.cancelFleetDeploymentV2WithHttpInfoAsync(String deploymentId) Cancel a deployment.Create a configuration deployment.Create a configuration deployment.Create a new deployment to apply configuration changes to a fleet of hosts matching the specified filter query.Create a configuration deployment.Upgrade hosts.Upgrade hosts.Create and immediately start a new package upgrade on hosts matching the specified filter query.Upgrade hosts.Create a schedule.Create a schedule.Create a new schedule for automated package upgrades.Create a schedule.voidDelete a schedule.Delete a schedule.Delete a schedule permanently.Delete a schedule.Get the API client.getFleetAgentDetailV2(String agentKey) Get detailed information about an agent.getFleetAgentDetailV2(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters) Get detailed information about an agent.getFleetAgentDetailV2Async(String agentKey) Get detailed information about an agent.getFleetAgentDetailV2Async(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters) Get detailed information about an agent.getFleetAgentDetailV2WithHttpInfo(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters) Retrieve detailed information about a specific Datadog Agent.getFleetAgentDetailV2WithHttpInfoAsync(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters) Get detailed information about an agent.getFleetDeploymentV2(String deploymentId) Get a deployment by ID.getFleetDeploymentV2Async(String deploymentId) Get a deployment by ID.getFleetDeploymentV2WithHttpInfo(String deploymentId) Retrieve detailed information about a specific deployment, including its current status, configuration operations, and per-host execution status.getFleetDeploymentV2WithHttpInfoAsync(String deploymentId) Get a deployment by ID.Get a schedule by ID.Get a schedule by ID.Retrieve detailed information about a specific schedule by its unique identifier.Get a schedule by ID.List all Datadog Agents.List all Datadog Agents.List all Datadog Agents.List all Datadog Agents.Retrieve a paginated list of Datadog Agents.listFleetAgentsV2WithHttpInfoAsync(FleetAutomationApi.ListFleetAgentsV2OptionalParameters parameters) List all Datadog Agents.listFleetAgentTracers(String agentKey) List tracers for a specific agent.listFleetAgentTracers(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters) List tracers for a specific agent.listFleetAgentTracersAsync(String agentKey) List tracers for a specific agent.listFleetAgentTracersAsync(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters) List tracers for a specific agent.listFleetAgentTracersWithHttpInfo(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters) Retrieve a paginated list of tracers for a specific agent.listFleetAgentTracersWithHttpInfoAsync(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters) List tracers for a specific agent.List available Datadog Agent versions.List available Datadog Agent versions.Retrieve the list of Datadog Agent versions available for deployment.List available Datadog Agent versions.List all deployments.List all deployments.List all deployments.List all deployments.listFleetDeploymentsV2WithHttpInfo(FleetAutomationApi.ListFleetDeploymentsV2OptionalParameters parameters) Retrieve a paginated list of all deployments for fleet automation.listFleetDeploymentsV2WithHttpInfoAsync(FleetAutomationApi.ListFleetDeploymentsV2OptionalParameters parameters) List all deployments.List all schedules.List all schedules.Retrieve all upgrade schedules for the organization.List all schedules.List all fleet tracers.List all fleet tracers.List all fleet tracers.List all fleet tracers.Retrieve a paginated list of all fleet tracers.List all fleet tracers.voidsetApiClient(ApiClient apiClient) Set the API client.Trigger a schedule deployment.Trigger a schedule deployment.Manually trigger a schedule to immediately create and start a deployment.Trigger a schedule deployment.Update a schedule.Update a schedule.Partially update a schedule by providing only the fields you want to change.Update a schedule.
-
Constructor Details
-
FleetAutomationApi
public FleetAutomationApi() -
FleetAutomationApi
-
-
Method Details
-
getApiClient
Get the API client.- Returns:
- API client
-
setApiClient
Set the API client.- Parameters:
apiClient- an instance of API client
-
cancelFleetDeploymentV2
public FleetDeploymentV2CancelResponse cancelFleetDeploymentV2(String deploymentId) throws ApiException Cancel a deployment.- Parameters:
deploymentId- The unique identifier of the deployment to cancel. (required)- Returns:
- FleetDeploymentV2CancelResponse
- Throws:
ApiException- if fails to make API call
-
cancelFleetDeploymentV2Async
public CompletableFuture<FleetDeploymentV2CancelResponse> cancelFleetDeploymentV2Async(String deploymentId) Cancel a deployment.See
cancelFleetDeploymentV2WithHttpInfoAsync(java.lang.String).- Parameters:
deploymentId- The unique identifier of the deployment to cancel. (required)- Returns:
- CompletableFuture<FleetDeploymentV2CancelResponse>
-
cancelFleetDeploymentV2WithHttpInfo
public ApiResponse<FleetDeploymentV2CancelResponse> cancelFleetDeploymentV2WithHttpInfo(String deploymentId) throws ApiException 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 status. - 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.
Only deployments with a
pendingorrunningstatus 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.- Parameters:
deploymentId- The unique identifier of the deployment to cancel. (required)- Returns:
- ApiResponse<FleetDeploymentV2CancelResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
cancelFleetDeploymentV2WithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetDeploymentV2CancelResponse>> cancelFleetDeploymentV2WithHttpInfoAsync(String deploymentId) Cancel a deployment.- Parameters:
deploymentId- The unique identifier of the deployment to cancel. (required)- Returns:
- CompletableFuture<ApiResponse<FleetDeploymentV2CancelResponse>>
-
createFleetDeploymentConfigureV2
public FleetDeploymentConfigureV2DryRunResponse createFleetDeploymentConfigureV2(FleetDeploymentConfigureV2CreateRequest body) throws ApiException Create a configuration deployment.- Parameters:
body- Request payload containing the deployment details. (required)- Returns:
- FleetDeploymentConfigureV2DryRunResponse
- Throws:
ApiException- if fails to make API call
-
createFleetDeploymentConfigureV2Async
public CompletableFuture<FleetDeploymentConfigureV2DryRunResponse> createFleetDeploymentConfigureV2Async(FleetDeploymentConfigureV2CreateRequest body) Create a configuration deployment.- Parameters:
body- Request payload containing the deployment details. (required)- Returns:
- CompletableFuture<FleetDeploymentConfigureV2DryRunResponse>
-
createFleetDeploymentConfigureV2WithHttpInfo
public ApiResponse<FleetDeploymentConfigureV2DryRunResponse> createFleetDeploymentConfigureV2WithHttpInfo(FleetDeploymentConfigureV2CreateRequest body) throws ApiException 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.You can optionally use
target_packagesto 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_runtotrueto 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_queryorconfig_operationsis 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.- Parameters:
body- Request payload containing the deployment details. (required)- Returns:
- ApiResponse<FleetDeploymentConfigureV2DryRunResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 429 Too many requests -
-
createFleetDeploymentConfigureV2WithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetDeploymentConfigureV2DryRunResponse>> createFleetDeploymentConfigureV2WithHttpInfoAsync(FleetDeploymentConfigureV2CreateRequest body) Create a configuration deployment.- Parameters:
body- Request payload containing the deployment details. (required)- Returns:
- CompletableFuture<ApiResponse<FleetDeploymentConfigureV2DryRunResponse>>
-
createFleetDeploymentUpgradeV2
public FleetDeploymentV2CreateResponse createFleetDeploymentUpgradeV2(FleetDeploymentPackageUpgradeV2CreateRequest body) throws ApiException Upgrade hosts.- Parameters:
body- Request payload containing the package upgrade details. (required)- Returns:
- FleetDeploymentV2CreateResponse
- Throws:
ApiException- if fails to make API call
-
createFleetDeploymentUpgradeV2Async
public CompletableFuture<FleetDeploymentV2CreateResponse> createFleetDeploymentUpgradeV2Async(FleetDeploymentPackageUpgradeV2CreateRequest body) Upgrade hosts.- Parameters:
body- Request payload containing the package upgrade details. (required)- Returns:
- CompletableFuture<FleetDeploymentV2CreateResponse>
-
createFleetDeploymentUpgradeV2WithHttpInfo
public ApiResponse<FleetDeploymentV2CreateResponse> createFleetDeploymentUpgradeV2WithHttpInfo(FleetDeploymentPackageUpgradeV2CreateRequest body) throws ApiException 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: 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_queryortarget_packagesis 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.- Parameters:
body- Request payload containing the package upgrade details. (required)- Returns:
- ApiResponse<FleetDeploymentV2CreateResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 409 Conflict - 429 Too many requests -
-
createFleetDeploymentUpgradeV2WithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetDeploymentV2CreateResponse>> createFleetDeploymentUpgradeV2WithHttpInfoAsync(FleetDeploymentPackageUpgradeV2CreateRequest body) Upgrade hosts.- Parameters:
body- Request payload containing the package upgrade details. (required)- Returns:
- CompletableFuture<ApiResponse<FleetDeploymentV2CreateResponse>>
-
createFleetSchedule
public FleetScheduleResponse createFleetSchedule(FleetScheduleCreateRequest body) throws ApiException Create a schedule.See
createFleetScheduleWithHttpInfo(com.datadog.api.client.v2.model.FleetScheduleCreateRequest).- Parameters:
body- Request payload containing the schedule details. (required)- Returns:
- FleetScheduleResponse
- Throws:
ApiException- if fails to make API call
-
createFleetScheduleAsync
public CompletableFuture<FleetScheduleResponse> createFleetScheduleAsync(FleetScheduleCreateRequest body) Create a schedule.See
createFleetScheduleWithHttpInfoAsync(com.datadog.api.client.v2.model.FleetScheduleCreateRequest).- Parameters:
body- Request payload containing the schedule details. (required)- Returns:
- CompletableFuture<FleetScheduleResponse>
-
createFleetScheduleWithHttpInfo
public ApiResponse<FleetScheduleResponse> createFleetScheduleWithHttpInfo(FleetScheduleCreateRequest body) throws ApiException 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.
- Parameters:
body- Request payload containing the schedule details. (required)- Returns:
- ApiResponse<FleetScheduleResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 201 CREATED - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 429 Too many requests -
-
createFleetScheduleWithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetScheduleResponse>> createFleetScheduleWithHttpInfoAsync(FleetScheduleCreateRequest body) Create a schedule.See
createFleetScheduleWithHttpInfo(com.datadog.api.client.v2.model.FleetScheduleCreateRequest).- Parameters:
body- Request payload containing the schedule details. (required)- Returns:
- CompletableFuture<ApiResponse<FleetScheduleResponse>>
-
deleteFleetSchedule
Delete a schedule.- Parameters:
id- The unique identifier of the schedule to delete. (required)- Throws:
ApiException- if fails to make API call
-
deleteFleetScheduleAsync
Delete a schedule.- Parameters:
id- The unique identifier of the schedule to delete. (required)- Returns:
- CompletableFuture
-
deleteFleetScheduleWithHttpInfo
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.
- Parameters:
id- The unique identifier of the schedule to delete. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 204 Schedule successfully deleted. - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
deleteFleetScheduleWithHttpInfoAsync
Delete a schedule.- Parameters:
id- The unique identifier of the schedule to delete. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
getFleetAgentDetailV2
Get detailed information about an agent.- Parameters:
agentKey- The unique identifier (Agent key) for the Datadog Agent. Must be a 32-character lowercase hexadecimal string. (required)- Returns:
- FleetAgentDetailV2Response
- Throws:
ApiException- if fails to make API call
-
getFleetAgentDetailV2Async
Get detailed information about an agent.- Parameters:
agentKey- The unique identifier (Agent key) for the Datadog Agent. Must be a 32-character lowercase hexadecimal string. (required)- Returns:
- CompletableFuture<FleetAgentDetailV2Response>
-
getFleetAgentDetailV2
public FleetAgentDetailV2Response getFleetAgentDetailV2(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters) throws ApiException Get detailed information about an agent.- 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.- Returns:
- FleetAgentDetailV2Response
- Throws:
ApiException- if fails to make API call
-
getFleetAgentDetailV2Async
public CompletableFuture<FleetAgentDetailV2Response> getFleetAgentDetailV2Async(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters) Get detailed information about an agent.- 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.- Returns:
- CompletableFuture<FleetAgentDetailV2Response>
-
getFleetAgentDetailV2WithHttpInfo
public ApiResponse<FleetAgentDetailV2Response> getFleetAgentDetailV2WithHttpInfo(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters) throws ApiException Retrieve detailed information about a specific Datadog Agent.By default, only
agent_infosis returned. Use theincludequery parameter to request additional data:integrationsand/orconfiguration_files.- 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.- Returns:
- ApiResponse<FleetAgentDetailV2Response>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
getFleetAgentDetailV2WithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetAgentDetailV2Response>> getFleetAgentDetailV2WithHttpInfoAsync(String agentKey, FleetAutomationApi.GetFleetAgentDetailV2OptionalParameters parameters) Get detailed information about an agent.- 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.- Returns:
- CompletableFuture<ApiResponse<FleetAgentDetailV2Response>>
-
getFleetDeploymentV2
public FleetDeploymentV2DetailResponse getFleetDeploymentV2(String deploymentId) throws ApiException Get a deployment by ID.- Parameters:
deploymentId- The unique identifier of the deployment to retrieve. (required)- Returns:
- FleetDeploymentV2DetailResponse
- Throws:
ApiException- if fails to make API call
-
getFleetDeploymentV2Async
public CompletableFuture<FleetDeploymentV2DetailResponse> getFleetDeploymentV2Async(String deploymentId) Get a deployment by ID.See
getFleetDeploymentV2WithHttpInfoAsync(java.lang.String).- Parameters:
deploymentId- The unique identifier of the deployment to retrieve. (required)- Returns:
- CompletableFuture<FleetDeploymentV2DetailResponse>
-
getFleetDeploymentV2WithHttpInfo
public ApiResponse<FleetDeploymentV2DetailResponse> getFleetDeploymentV2WithHttpInfo(String deploymentId) throws ApiException Retrieve detailed information about a specific deployment, including its current status, configuration operations, and per-host execution status.Returns a 404 if no deployment matches the given ID or if you do not have access to it.
- Parameters:
deploymentId- The unique identifier of the deployment to retrieve. (required)- Returns:
- ApiResponse<FleetDeploymentV2DetailResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
getFleetDeploymentV2WithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetDeploymentV2DetailResponse>> getFleetDeploymentV2WithHttpInfoAsync(String deploymentId) Get a deployment by ID.- Parameters:
deploymentId- The unique identifier of the deployment to retrieve. (required)- Returns:
- CompletableFuture<ApiResponse<FleetDeploymentV2DetailResponse>>
-
getFleetScheduleV2
Get a schedule by ID.- Parameters:
id- The unique identifier of the schedule to retrieve. (required)- Returns:
- FleetScheduleV2Response
- Throws:
ApiException- if fails to make API call
-
getFleetScheduleV2Async
Get a schedule by ID.- Parameters:
id- The unique identifier of the schedule to retrieve. (required)- Returns:
- CompletableFuture<FleetScheduleV2Response>
-
getFleetScheduleV2WithHttpInfo
public ApiResponse<FleetScheduleV2Response> getFleetScheduleV2WithHttpInfo(String id) throws ApiException Retrieve detailed information about a specific schedule by its unique identifier.- Parameters:
id- The unique identifier of the schedule to retrieve. (required)- Returns:
- ApiResponse<FleetScheduleV2Response>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
getFleetScheduleV2WithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetScheduleV2Response>> getFleetScheduleV2WithHttpInfoAsync(String id) Get a schedule by ID.- Parameters:
id- The unique identifier of the schedule to retrieve. (required)- Returns:
- CompletableFuture<ApiResponse<FleetScheduleV2Response>>
-
listFleetAgentsV2
List all Datadog Agents.- Returns:
- FleetAgentsV2Response
- Throws:
ApiException- if fails to make API call
-
listFleetAgentsV2Async
List all Datadog Agents.- Returns:
- CompletableFuture<FleetAgentsV2Response>
-
listFleetAgentsV2
public FleetAgentsV2Response listFleetAgentsV2(FleetAutomationApi.ListFleetAgentsV2OptionalParameters parameters) throws ApiException List all Datadog Agents.- Parameters:
parameters- Optional parameters for the request.- Returns:
- FleetAgentsV2Response
- Throws:
ApiException- if fails to make API call
-
listFleetAgentsV2Async
public CompletableFuture<FleetAgentsV2Response> listFleetAgentsV2Async(FleetAutomationApi.ListFleetAgentsV2OptionalParameters parameters) List all Datadog Agents.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<FleetAgentsV2Response>
-
listFleetAgentsV2WithHttpInfo
public ApiResponse<FleetAgentsV2Response> listFleetAgentsV2WithHttpInfo(FleetAutomationApi.ListFleetAgentsV2OptionalParameters parameters) throws ApiException Retrieve a paginated list of Datadog Agents.Returns agents with support for pagination, sorting, and filtering. Use
page_numberandpage_sizeto navigate pages,filterto narrow by field values, andtagsto filter by agent tags.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<FleetAgentsV2Response>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 429 Too many requests -
-
listFleetAgentsV2WithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetAgentsV2Response>> listFleetAgentsV2WithHttpInfoAsync(FleetAutomationApi.ListFleetAgentsV2OptionalParameters parameters) List all Datadog Agents.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<FleetAgentsV2Response>>
-
listFleetAgentTracers
List tracers for a specific agent.- Parameters:
agentKey- The unique identifier (agent key) for the Datadog Agent. (required)- Returns:
- FleetTracersResponse
- Throws:
ApiException- if fails to make API call
-
listFleetAgentTracersAsync
List tracers for a specific agent.- Parameters:
agentKey- The unique identifier (agent key) for the Datadog Agent. (required)- Returns:
- CompletableFuture<FleetTracersResponse>
-
listFleetAgentTracers
public FleetTracersResponse listFleetAgentTracers(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters) throws ApiException List tracers for a specific agent.- Parameters:
agentKey- The unique identifier (agent key) for the Datadog Agent. (required)parameters- Optional parameters for the request.- Returns:
- FleetTracersResponse
- Throws:
ApiException- if fails to make API call
-
listFleetAgentTracersAsync
public CompletableFuture<FleetTracersResponse> listFleetAgentTracersAsync(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters) List tracers for a specific agent.- Parameters:
agentKey- The unique identifier (agent key) for the Datadog Agent. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<FleetTracersResponse>
-
listFleetAgentTracersWithHttpInfo
public ApiResponse<FleetTracersResponse> listFleetAgentTracersWithHttpInfo(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters) throws ApiException Retrieve a paginated list of tracers for a specific agent.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.
- Parameters:
agentKey- The unique identifier (agent key) for the Datadog Agent. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<FleetTracersResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
listFleetAgentTracersWithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetTracersResponse>> listFleetAgentTracersWithHttpInfoAsync(String agentKey, FleetAutomationApi.ListFleetAgentTracersOptionalParameters parameters) List tracers for a specific agent.- Parameters:
agentKey- The unique identifier (agent key) for the Datadog Agent. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<FleetTracersResponse>>
-
listFleetAgentVersionsV2
List available Datadog Agent versions.- Returns:
- FleetAgentVersionsV2Response
- Throws:
ApiException- if fails to make API call
-
listFleetAgentVersionsV2Async
List available Datadog Agent versions.- Returns:
- CompletableFuture<FleetAgentVersionsV2Response>
-
listFleetAgentVersionsV2WithHttpInfo
public ApiResponse<FleetAgentVersionsV2Response> listFleetAgentVersionsV2WithHttpInfo() throws ApiExceptionRetrieve the list of Datadog Agent versions available for deployment.Returns
200with an emptydataarray if the Agent package exists in the catalog but has no available versions, and404only if the Agent package itself is absent from the catalog.- Returns:
- ApiResponse<FleetAgentVersionsV2Response>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 401 Unauthorized - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
listFleetAgentVersionsV2WithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetAgentVersionsV2Response>> listFleetAgentVersionsV2WithHttpInfoAsync()List available Datadog Agent versions.- Returns:
- CompletableFuture<ApiResponse<FleetAgentVersionsV2Response>>
-
listFleetDeploymentsV2
List all deployments.- Returns:
- FleetDeploymentsV2Response
- Throws:
ApiException- if fails to make API call
-
listFleetDeploymentsV2Async
List all deployments.- Returns:
- CompletableFuture<FleetDeploymentsV2Response>
-
listFleetDeploymentsV2
public FleetDeploymentsV2Response listFleetDeploymentsV2(FleetAutomationApi.ListFleetDeploymentsV2OptionalParameters parameters) throws ApiException List all deployments.- Parameters:
parameters- Optional parameters for the request.- Returns:
- FleetDeploymentsV2Response
- Throws:
ApiException- if fails to make API call
-
listFleetDeploymentsV2Async
public CompletableFuture<FleetDeploymentsV2Response> listFleetDeploymentsV2Async(FleetAutomationApi.ListFleetDeploymentsV2OptionalParameters parameters) List all deployments.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<FleetDeploymentsV2Response>
-
listFleetDeploymentsV2WithHttpInfo
public ApiResponse<FleetDeploymentsV2Response> listFleetDeploymentsV2WithHttpInfo(FleetAutomationApi.ListFleetDeploymentsV2OptionalParameters parameters) throws ApiException Retrieve a paginated list of all deployments for fleet automation.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<FleetDeploymentsV2Response>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 429 Too many requests -
-
listFleetDeploymentsV2WithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetDeploymentsV2Response>> listFleetDeploymentsV2WithHttpInfoAsync(FleetAutomationApi.ListFleetDeploymentsV2OptionalParameters parameters) List all deployments.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<FleetDeploymentsV2Response>>
-
listFleetSchedulesV2
List all schedules.- Returns:
- FleetSchedulesV2Response
- Throws:
ApiException- if fails to make API call
-
listFleetSchedulesV2Async
List all schedules.- Returns:
- CompletableFuture<FleetSchedulesV2Response>
-
listFleetSchedulesV2WithHttpInfo
Retrieve all upgrade schedules for the organization.Schedules automate package upgrades by defining maintenance windows and recurrence rules. Each schedule automatically creates deployments based on its configuration.
- Returns:
- ApiResponse<FleetSchedulesV2Response>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 429 Too many requests -
-
listFleetSchedulesV2WithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetSchedulesV2Response>> listFleetSchedulesV2WithHttpInfoAsync()List all schedules.- Returns:
- CompletableFuture<ApiResponse<FleetSchedulesV2Response>>
-
listFleetTracers
List all fleet tracers.- Returns:
- FleetTracersResponse
- Throws:
ApiException- if fails to make API call
-
listFleetTracersAsync
List all fleet tracers.- Returns:
- CompletableFuture<FleetTracersResponse>
-
listFleetTracers
public FleetTracersResponse listFleetTracers(FleetAutomationApi.ListFleetTracersOptionalParameters parameters) throws ApiException List all fleet tracers.- Parameters:
parameters- Optional parameters for the request.- Returns:
- FleetTracersResponse
- Throws:
ApiException- if fails to make API call
-
listFleetTracersAsync
public CompletableFuture<FleetTracersResponse> listFleetTracersAsync(FleetAutomationApi.ListFleetTracersOptionalParameters parameters) List all fleet tracers.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<FleetTracersResponse>
-
listFleetTracersWithHttpInfo
public ApiResponse<FleetTracersResponse> listFleetTracersWithHttpInfo(FleetAutomationApi.ListFleetTracersOptionalParameters parameters) throws ApiException Retrieve a paginated list of all fleet tracers.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_numberandpage_sizequery parameters to paginate through results.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<FleetTracersResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
listFleetTracersWithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetTracersResponse>> listFleetTracersWithHttpInfoAsync(FleetAutomationApi.ListFleetTracersOptionalParameters parameters) List all fleet tracers.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<FleetTracersResponse>>
-
triggerFleetSchedule
Trigger a schedule deployment.- Parameters:
id- The unique identifier of the schedule to trigger. (required)- Returns:
- FleetDeploymentResponse
- Throws:
ApiException- if fails to make API call
-
triggerFleetScheduleAsync
Trigger a schedule deployment.See
triggerFleetScheduleWithHttpInfoAsync(java.lang.String).- Parameters:
id- The unique identifier of the schedule to trigger. (required)- Returns:
- CompletableFuture<FleetDeploymentResponse>
-
triggerFleetScheduleWithHttpInfo
public ApiResponse<FleetDeploymentResponse> triggerFleetScheduleWithHttpInfo(String id) throws ApiException 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.
- Parameters:
id- The unique identifier of the schedule to trigger. (required)- Returns:
- ApiResponse<FleetDeploymentResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details 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 -
-
triggerFleetScheduleWithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetDeploymentResponse>> triggerFleetScheduleWithHttpInfoAsync(String id) Trigger a schedule deployment.- Parameters:
id- The unique identifier of the schedule to trigger. (required)- Returns:
- CompletableFuture<ApiResponse<FleetDeploymentResponse>>
-
updateFleetSchedule
public FleetScheduleResponse updateFleetSchedule(String id, FleetSchedulePatchRequest body) throws ApiException Update a schedule.- Parameters:
id- The unique identifier of the schedule to update. (required)body- Request payload containing the fields to update. (required)- Returns:
- FleetScheduleResponse
- Throws:
ApiException- if fails to make API call
-
updateFleetScheduleAsync
public CompletableFuture<FleetScheduleResponse> updateFleetScheduleAsync(String id, FleetSchedulePatchRequest body) Update a schedule.- Parameters:
id- The unique identifier of the schedule to update. (required)body- Request payload containing the fields to update. (required)- Returns:
- CompletableFuture<FleetScheduleResponse>
-
updateFleetScheduleWithHttpInfo
public ApiResponse<FleetScheduleResponse> updateFleetScheduleWithHttpInfo(String id, FleetSchedulePatchRequest body) throws ApiException 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.
- Parameters:
id- The unique identifier of the schedule to update. (required)body- Request payload containing the fields to update. (required)- Returns:
- ApiResponse<FleetScheduleResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 401 Unauthorized - 403 Forbidden - 404 Not Found - 429 Too many requests -
-
updateFleetScheduleWithHttpInfoAsync
public CompletableFuture<ApiResponse<FleetScheduleResponse>> updateFleetScheduleWithHttpInfoAsync(String id, FleetSchedulePatchRequest body) Update a schedule.- Parameters:
id- The unique identifier of the schedule to update. (required)body- Request payload containing the fields to update. (required)- Returns:
- CompletableFuture<ApiResponse<FleetScheduleResponse>>
-