--- title: List all Datadog Agents description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Fleet Automation --- # List all Datadog Agents{% #list-all-datadog-agents %} 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/agents | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/unstable/fleet/agents | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/unstable/fleet/agents | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/unstable/fleet/agents | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/unstable/fleet/agents | | app.datadoghq.com | GET https://api.datadoghq.com/api/unstable/fleet/agents | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/unstable/fleet/agents | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/unstable/fleet/agents | ### Overview Retrieve a paginated list of all Datadog Agents. This endpoint returns a paginated list of all Datadog Agents with support for pagination, sorting, and filtering. Use the `page_number` and `page_size` query parameters to paginate through results. This endpoint requires the `hosts_read` permission. ### Arguments #### Query Strings | Name | Type | Description | | --------------- | ------- | ---------------------------------------------------------------------------------- | | page_number | integer | Page number for pagination (starts at 0). | | page_size | integer | Number of results per page (must be greater than 0 and less than or equal to 100). | | sort_attribute | string | Attribute to sort by. | | sort_descending | boolean | Sort order (true for descending, false for ascending). | | tags | string | Comma-separated list of tags to filter agents. | | filter | string | Filter string for narrowing down agent results. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing a paginated list of Datadog Agents. | Parent field | Field | Type | Description | | ------------ | -------------------------------------- | -------- | ---------------------------------------------------------------------- | | | data [*required*] | object | The response data containing status and agents array. | | data | attributes [*required*] | object | Attributes of the fleet agents response containing the list of agents. | | attributes | agents | [object] | Array of agents matching the query criteria. | | agents | agent_version | string | The Datadog Agent version. | | agents | api_key_name | string | The API key name (if available and not redacted). | | agents | api_key_uuid | string | The API key UUID. | | agents | cloud_provider | string | The cloud provider where the agent is running. | | agents | cluster_name | string | Kubernetes cluster name (if applicable). | | agents | datadog_agent_key | string | The unique agent key identifier. | | agents | enabled_products | [string] | Datadog products enabled on the agent. | | agents | envs | [string] | Environments the agent is reporting from. | | agents | first_seen_at | int64 | Timestamp when the agent was first seen. | | agents | hostname | string | The hostname of the agent. | | agents | ip_addresses | [string] | IP addresses of the agent. | | agents | is_single_step_instrumentation_enabled | boolean | Whether single-step instrumentation is enabled. | | agents | last_restart_at | int64 | Timestamp of the last agent restart. | | agents | os | string | The operating system. | | agents | otel_collector_version | string | OpenTelemetry collector version (if applicable). | | agents | otel_collector_versions | [string] | List of OpenTelemetry collector versions (if applicable). | | agents | pod_name | string | Kubernetes pod name (if applicable). | | agents | remote_agent_management | string | Remote agent management status. | | agents | remote_config_status | string | Remote configuration status. | | agents | services | [string] | Services running on the agent. | | agents | tags | [object] | Tags associated with the agent. | | tags | key | string | The tag key. | | tags | value | string | The tag value. | | agents | team | string | Team associated with the agent. | | data | id [*required*] | string | Status identifier. | | data | type [*required*] | string | Resource type. | | | meta | object | Metadata for the list of agents response. | | meta | total_filtered_count | int64 | Total number of agents matching the filter criteria across all pages. | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "agents": [ { "agent_version": "7.50.0", "api_key_name": "Production API Key", "api_key_uuid": "a1b2c3d4-e5f6-4321-a123-123456789abc", "cloud_provider": "aws", "cluster_name": "string", "datadog_agent_key": "my-agent-hostname", "enabled_products": [], "envs": [], "first_seen_at": "integer", "hostname": "my-hostname", "ip_addresses": [], "is_single_step_instrumentation_enabled": false, "last_restart_at": "integer", "os": "linux", "otel_collector_version": "string", "otel_collector_versions": [], "pod_name": "string", "remote_agent_management": "enabled", "remote_config_status": "connected", "services": [], "tags": [ { "key": "string", "value": "string" } ], "team": "string" } ] }, "id": "done", "type": "status" }, "meta": { "total_filtered_count": 150 } } ``` {% /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="404" %} Not Found {% 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/agents" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ List all Datadog Agents 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_agents"] = True with ApiClient(configuration) as api_client: api_instance = FleetAutomationApi(api_client) response = api_instance.list_fleet_agents() 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 Datadog Agents returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.list_fleet_agents".to_sym] = true end api_instance = DatadogAPIClient::V2::FleetAutomationAPI.new p api_instance.list_fleet_agents() ``` #### 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 Datadog Agents 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.ListFleetAgents", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewFleetAutomationApi(apiClient) resp, r, err := api.ListFleetAgents(ctx, *datadogV2.NewListFleetAgentsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `FleetAutomationApi.ListFleetAgents`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `FleetAutomationApi.ListFleetAgents`:\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 Datadog Agents 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.FleetAgentsResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.listFleetAgents", true); FleetAutomationApi apiInstance = new FleetAutomationApi(defaultClient); try { FleetAgentsResponse result = apiInstance.listFleetAgents(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling FleetAutomationApi#listFleetAgents"); 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 Datadog Agents 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::ListFleetAgentsOptionalParams; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.ListFleetAgents", true); let api = FleetAutomationAPI::with_config(configuration); let resp = api .list_fleet_agents(ListFleetAgentsOptionalParams::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 Datadog Agents returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.listFleetAgents"] = true; const apiInstance = new v2.FleetAutomationApi(configuration); apiInstance .listFleetAgents() .then((data: v2.FleetAgentsResponse) => { 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 %}