--- title: List all deployments description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Fleet Automation --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # List all deployments{% #list-all-deployments %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/fleet/deployments | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/fleet/deployments | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/fleet/deployments | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/fleet/deployments | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/fleet/deployments | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/fleet/deployments | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/fleet/deployments | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/fleet/deployments | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/fleet/deployments | ### Overview Retrieve a paginated list of all deployments for fleet automation. 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_number | integer | Page number for pagination, starting at 0. | | sort | string | Field to sort results by (for example, `start_date`). Must be a supported field name; unsupported values return a 400 error. | | ascending | boolean | Set to `true` to sort in ascending order. This setting has no effect unless `sort` is also set. Defaults to descending order. | | filter | string | | ### 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 v2 API response. | | attributes | author | string | Handle of the user who triggered the deployment. | | attributes | config_operations | [object] | Ordered list of configuration file operations applied by this deployment. Absent for package deployments, which have no configuration file operations. | | 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 | duration_seconds | int64 | Duration of the deployment in seconds, computed as `finished_at - started_at`. Zero if the deployment has not finished. | | attributes | error_summary | string | Top-level error message for the deployment. Populated only when the deployment has failed. | | attributes | estimated_finished_at | int64 | Estimated completion time of the deployment as a Unix timestamp. Zero if not available. | | attributes | finished_at | int64 | Time the deployment finished as a Unix timestamp. Zero if not yet finished. | | attributes | is_scheduled | boolean | Whether this deployment was triggered by a schedule (`schedule_id` is non-empty). | | attributes | query | string | Query used to filter and select target hosts for the deployment. | | attributes | schedule_id | string | Identifier of the schedule that triggered this deployment. Empty if triggered manually. | | attributes | started_at | int64 | Time the deployment started as a Unix timestamp. Zero if not yet started. | | attributes | status | string | Current high-level status of the deployment (for example, "pending", "running", "completed", "failed"). | | attributes | target_versions | [string] | Package versions targeted by this deployment. | | attributes | total_hosts | int64 | Total number of hosts targeted by this deployment. | | attributes | update_type | string | Type of update operation performed by this deployment (for example, "update_config_operations", "update_package"). | | 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 v2 list of deployments, including pagination information. | | meta | page | object | Pagination details for the v2 list of deployments. | | page | total_count | int64 | Total number of deployments available across all pages. | | page | total_filtered_count | int64 | Total number of deployments matching the current filter query. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "author": "alice@datadoghq.com", "config_operations": [ { "file_op": "merge-patch", "file_path": "/datadog.yaml", "patch": { "apm_config": { "enabled": true }, "log_level": "debug", "logs_enabled": true } } ], "duration_seconds": 1000, "error_summary": "A host failed to update", "estimated_finished_at": 1699999999, "finished_at": 0, "is_scheduled": true, "query": "env:prod AND service:web", "schedule_id": "sched-123", "started_at": 1699990000, "status": "pending", "target_versions": [ "7.52.0" ], "total_hosts": 42, "update_type": "update_config_operations" }, "id": "k7Q-3mX-p9Z", "type": "deployment" } ], "meta": { "page": { "total_count": 25, "total_filtered_count": 10 } } } ``` {% /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/v2/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() with ApiClient(configuration) as api_client: api_instance = FleetAutomationApi(api_client) response = api_instance.list_fleet_deployments_v2() 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" api_instance = DatadogAPIClient::V2::FleetAutomationAPI.new p api_instance.list_fleet_deployments_v2() ``` #### 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() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewFleetAutomationApi(apiClient) resp, r, err := api.ListFleetDeploymentsV2(ctx, *datadogV2.NewListFleetDeploymentsV2OptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FleetAutomationApi.ListFleetDeploymentsV2`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `FleetAutomationApi.ListFleetDeploymentsV2`:\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.FleetDeploymentsV2Response; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); FleetAutomationApi apiInstance = new FleetAutomationApi(defaultClient); try { FleetDeploymentsV2Response result = apiInstance.listFleetDeploymentsV2(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling FleetAutomationApi#listFleetDeploymentsV2"); 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::ListFleetDeploymentsV2OptionalParams; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = FleetAutomationAPI::with_config(configuration); let resp = api .list_fleet_deployments_v2(ListFleetDeploymentsV2OptionalParams::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(); const apiInstance = new v2.FleetAutomationApi(configuration); apiInstance .listFleetDeploymentsV2() .then((data: v2.FleetDeploymentsV2Response) => { 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 %}