--- title: List all deployments description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Fleet Automation --- # List all deployments{% #list-all-deployments %} Copy pageCopied {% tab title="v2" %} This endpoint is in Preview and may introduce breaking changes. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/unstable/fleet/deployments | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/unstable/fleet/deployments | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/unstable/fleet/deployments | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/unstable/fleet/deployments | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/unstable/fleet/deployments | | app.datadoghq.com | GET https://api.datadoghq.com/api/unstable/fleet/deployments | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/unstable/fleet/deployments | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/unstable/fleet/deployments | ### Overview Retrieve a list of all deployments for fleet automation. Use the `page_size` and `page_offset` parameters to paginate results. This endpoint requires the `hosts_read` permission. ### Arguments #### Query Strings | Name | Type | Description | | ----------- | ------- | ----------------------------------------------------------------------------------------------- | | page_size | integer | Number of deployments to return per page. Maximum value is 100. | | page_offset | integer | Index of the first deployment to return. Use this with `page_size` to paginate through results. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing a paginated list of deployments. | Parent field | Field | Type | Description | | ----------------- | ---------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | [object] | Array of deployments matching the query criteria. | | data | attributes [*required*] | object | Attributes of a deployment in the response. | | attributes | config_operations | [object] | Ordered list of configuration file operations to perform on the target hosts. | | config_operations | file_op [*required*] | enum | Type of file operation to perform on the target configuration file. | | config_operations | file_path [*required*] | string | Absolute path to the target configuration file on the host. | | config_operations | patch | object | Patch data in JSON format to apply to the configuration file. When using `merge-patch`, this object is merged with the existing configuration, allowing you to add, update, or override specific fields without replacing the entire file. The structure must match the target configuration file format (for example, YAML structure for Datadog Agent config). Not applicable when using the `delete` operation. | | attributes | estimated_end_time_unix | int64 | Estimated completion time of the deployment as a Unix timestamp (seconds since epoch). | | attributes | filter_query | string | Query used to filter and select target hosts for the deployment. Uses the Datadog query syntax. | | attributes | high_level_status | string | Current high-level status of the deployment (for example, "pending", "running", "completed", "failed"). | | attributes | hosts | [object] | Paginated list of hosts in this deployment with their individual statuses. Only included when fetching a single deployment by ID. Use the `limit` and `page` query parameters to navigate through pages. Pagination metadata is included in the response `meta.hosts` field. | | hosts | error | string | Error message if the deployment failed on this host. | | hosts | hostname | string | The hostname of the agent. | | hosts | status | string | Current deployment status for this specific host. | | hosts | versions | [object] | List of packages and their versions currently installed on this host. | | versions | current_version | string | The current version of the package on the host. | | versions | initial_version | string | The initial version of the package on the host before the deployment started. | | versions | package_name | string | The name of the package. | | versions | target_version | string | The target version that the deployment is attempting to install. | | attributes | packages | [object] | List of packages to deploy to target hosts. Present only for package upgrade deployments. | | packages | name [*required*] | string | The name of the package to deploy. | | packages | version [*required*] | string | The target version of the package to deploy. | | attributes | total_hosts | int64 | Total number of hosts targeted by this deployment. | | data | id [*required*] | string | Unique identifier for the deployment. | | data | type [*required*] | enum | The type of deployment resource. Allowed enum values: `deployment` | | | meta | object | Metadata for the list of deployments, including pagination information. | | meta | page | object | Pagination details for the list of deployments. | | page | total_count | int64 | Total number of deployments available across all pages. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "config_operations": [ { "file_op": "merge-patch", "file_path": "/datadog.yaml", "patch": { "apm_config": { "enabled": true }, "log_level": "debug", "logs_enabled": true } } ], "estimated_end_time_unix": 1699999999, "filter_query": "env:prod AND service:web", "high_level_status": "pending", "hosts": [ { "error": "", "hostname": "web-server-01.example.com", "status": "succeeded", "versions": [ { "current_version": "7.51.0", "initial_version": "7.51.0", "package_name": "datadog-agent", "target_version": "7.52.0" } ] } ], "packages": [ { "name": "datadog-agent", "version": "7.52.0" } ], "total_hosts": 42 }, "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", "type": "deployment" } ], "meta": { "page": { "total_count": 25 } } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/unstable/fleet/deployments" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ List all deployments returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.fleet_automation_api import FleetAutomationApi configuration = Configuration() configuration.unstable_operations["list_fleet_deployments"] = True with ApiClient(configuration) as api_client: api_instance = FleetAutomationApi(api_client) response = api_instance.list_fleet_deployments() print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # List all deployments returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.list_fleet_deployments".to_sym] = true end api_instance = DatadogAPIClient::V2::FleetAutomationAPI.new p api_instance.list_fleet_deployments() ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // List all deployments returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.ListFleetDeployments", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewFleetAutomationApi(apiClient) resp, r, err := api.ListFleetDeployments(ctx, *datadogV2.NewListFleetDeploymentsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FleetAutomationApi.ListFleetDeployments`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `FleetAutomationApi.ListFleetDeployments`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // List all deployments returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.FleetAutomationApi; import com.datadog.api.client.v2.model.FleetDeploymentsResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.listFleetDeployments", true); FleetAutomationApi apiInstance = new FleetAutomationApi(defaultClient); try { FleetDeploymentsResponse result = apiInstance.listFleetDeployments(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling FleetAutomationApi#listFleetDeployments"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // List all deployments returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_fleet_automation::FleetAutomationAPI; use datadog_api_client::datadogV2::api_fleet_automation::ListFleetDeploymentsOptionalParams; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.ListFleetDeployments", true); let api = FleetAutomationAPI::with_config(configuration); let resp = api .list_fleet_deployments(ListFleetDeploymentsOptionalParams::default()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * List all deployments returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.listFleetDeployments"] = true; const apiInstance = new v2.FleetAutomationApi(configuration); apiInstance .listFleetDeployments() .then((data: v2.FleetDeploymentsResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}