Get detailed information about an agent

This endpoint is in Preview and may introduce breaking changes. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/unstable/fleet/agents/{agent_key}https://api.ap2.datadoghq.com/api/unstable/fleet/agents/{agent_key}https://api.datadoghq.eu/api/unstable/fleet/agents/{agent_key}https://api.ddog-gov.com/api/unstable/fleet/agents/{agent_key}https://api.us2.ddog-gov.com/api/unstable/fleet/agents/{agent_key}https://api.datadoghq.com/api/unstable/fleet/agents/{agent_key}https://api.us3.datadoghq.com/api/unstable/fleet/agents/{agent_key}https://api.us5.datadoghq.com/api/unstable/fleet/agents/{agent_key}

Overview

Retrieve detailed information about a specific Datadog Agent. This endpoint returns comprehensive information about an agent including:

  • Agent details and metadata
  • Configured integrations organized by status (working, warning, error, missing)
  • Detected integrations
  • Configuration files and layers
This endpoint requires the hosts_read permission.

Arguments

Path Parameters

Name

Type

Description

agent_key [required]

string

The unique identifier (agent key) for the Datadog Agent.

Response

OK

Response containing detailed information about a specific agent.

Expand All

Field

Type

Description

data [required]

object

Represents detailed information about a specific Datadog Agent.

attributes [required]

object

Attributes for agent information.

agent_infos

object

Detailed information about a Datadog Agent.

agent_version

string

The Datadog Agent version.

api_key_name

string

The API key name (if available and not redacted).

api_key_uuid

string

The API key UUID.

cloud_provider

string

The cloud provider where the agent is running.

cluster_name

string

Kubernetes cluster name (if applicable).

datadog_agent_key

string

The unique agent key identifier.

enabled_products

[string]

Datadog products enabled on the agent.

env

[string]

Environments the agent is reporting from.

first_seen_at

int64

Timestamp when the agent was first seen.

hostname

string

The hostname of the agent.

hostname_aliases

[string]

Alternative hostname list for the agent.

install_method_installer_version

string

The version of the installer used.

install_method_tool

string

The tool used to install the agent.

ip_addresses

[string]

IP addresses of the agent.

is_single_step_instrumentation_enabled

boolean

Whether single-step instrumentation is enabled.

last_restart_at

int64

Timestamp of the last agent restart.

os

string

The operating system.

os_version

string

The operating system version.

otel_collector_version

string

OpenTelemetry collector version (if applicable).

otel_collector_versions

[string]

List of OpenTelemetry collector versions (if applicable).

otel_collectors

[object]

OpenTelemetry collectors associated with the agent (if applicable).

pod_name

string

Kubernetes pod name (if applicable).

python_version

string

The Python version used by the agent.

region

[string]

Regions where the agent is running.

remote_agent_management

string

Remote agent management status.

remote_config_status

string

Remote configuration status.

services

[string]

Services running on the agent.

tags

[string]

Tags associated with the agent.

team

string

Team associated with the agent.

configuration_files

object

Configuration information organized by layers.

compiled_configuration

string

The final compiled configuration.

env_configuration

string

Configuration from environment variables.

file_configuration

string

Configuration from files.

parsed_configuration

string

Parsed configuration output.

remote_configuration

string

Remote configuration settings.

runtime_configuration

string

Runtime configuration.

detected_integrations

[object]

List of detected integrations.

escaped_name

string

Escaped integration name.

prefix

string

Integration prefix identifier.

integrations

object

Integrations organized by their status.

configuration_files

[object]

Configuration files for integrations.

file_content

string

The raw content of the configuration file.

file_path

string

Path to the configuration file.

filename

string

Name of the configuration file.

datadog_agent_key

string

The unique agent key identifier.

error_integrations

[object]

Integrations with errors.

data_type

string

Type of data collected (metrics, logs).

error_messages

[string]

Error messages if the integration has issues.

init_config

string

Initialization configuration (YAML format).

instance_config

string

Instance-specific configuration (YAML format).

is_custom_check

boolean

Whether this is a custom integration.

log_config

string

Log collection configuration (YAML format).

name

string

Name of the integration instance.

source_index

int64

Index in the configuration file.

source_path

string

Path to the configuration file.

type

string

Integration type.

missing_integrations

[object]

Detected but not configured integrations.

escaped_name

string

Escaped integration name.

prefix

string

Integration prefix identifier.

warning_integrations

[object]

Integrations with warnings.

data_type

string

Type of data collected (metrics, logs).

error_messages

[string]

Error messages if the integration has issues.

init_config

string

Initialization configuration (YAML format).

instance_config

string

Instance-specific configuration (YAML format).

is_custom_check

boolean

Whether this is a custom integration.

log_config

string

Log collection configuration (YAML format).

name

string

Name of the integration instance.

source_index

int64

Index in the configuration file.

source_path

string

Path to the configuration file.

type

string

Integration type.

working_integrations

[object]

Integrations that are working correctly.

data_type

string

Type of data collected (metrics, logs).

error_messages

[string]

Error messages if the integration has issues.

init_config

string

Initialization configuration (YAML format).

instance_config

string

Instance-specific configuration (YAML format).

is_custom_check

boolean

Whether this is a custom integration.

log_config

string

Log collection configuration (YAML format).

name

string

Name of the integration instance.

source_index

int64

Index in the configuration file.

source_path

string

Path to the configuration file.

type

string

Integration type.

id [required]

string

The unique agent key identifier.

type [required]

enum

The type of Agent info resource. Allowed enum values: datadog_agent_key

default: datadog_agent_key

{
  "data": {
    "attributes": {
      "agent_infos": {
        "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": [],
        "env": [],
        "first_seen_at": "integer",
        "hostname": "my-hostname",
        "hostname_aliases": [],
        "install_method_installer_version": "1.2.3",
        "install_method_tool": "chef",
        "ip_addresses": [],
        "is_single_step_instrumentation_enabled": false,
        "last_restart_at": "integer",
        "os": "linux",
        "os_version": "Ubuntu 20.04",
        "otel_collector_version": "string",
        "otel_collector_versions": [],
        "otel_collectors": [],
        "pod_name": "string",
        "python_version": "3.9.5",
        "region": [],
        "remote_agent_management": "enabled",
        "remote_config_status": "connected",
        "services": [],
        "tags": [],
        "team": "string"
      },
      "configuration_files": {
        "compiled_configuration": "string",
        "env_configuration": "string",
        "file_configuration": "string",
        "parsed_configuration": "string",
        "remote_configuration": "string",
        "runtime_configuration": "string"
      },
      "detected_integrations": [
        {
          "escaped_name": "postgresql",
          "prefix": "postgres"
        }
      ],
      "integrations": {
        "configuration_files": [
          {
            "file_content": "string",
            "file_path": "/conf.d/postgres.d/postgres.yaml",
            "filename": "postgres.yaml"
          }
        ],
        "datadog_agent_key": "string",
        "error_integrations": [
          {
            "data_type": "metrics",
            "error_messages": [],
            "init_config": "string",
            "instance_config": "string",
            "is_custom_check": false,
            "log_config": "string",
            "name": "string",
            "source_index": "integer",
            "source_path": "string",
            "type": "postgres"
          }
        ],
        "missing_integrations": [
          {
            "escaped_name": "postgresql",
            "prefix": "postgres"
          }
        ],
        "warning_integrations": [
          {
            "data_type": "metrics",
            "error_messages": [],
            "init_config": "string",
            "instance_config": "string",
            "is_custom_check": false,
            "log_config": "string",
            "name": "string",
            "source_index": "integer",
            "source_path": "string",
            "type": "postgres"
          }
        ],
        "working_integrations": [
          {
            "data_type": "metrics",
            "error_messages": [],
            "init_config": "string",
            "instance_config": "string",
            "is_custom_check": false,
            "log_config": "string",
            "name": "string",
            "source_index": "integer",
            "source_path": "string",
            "type": "postgres"
          }
        ]
      }
    },
    "id": "my-agent-hostname",
    "type": "datadog_agent_key"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Unauthorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export agent_key="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/unstable/fleet/agents/${agent_key}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get detailed information about an agent 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["get_fleet_agent_info"] = True
with ApiClient(configuration) as api_client:
    api_instance = FleetAutomationApi(api_client)
    response = api_instance.get_fleet_agent_info(
        agent_key="agent_key",
    )

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Get detailed information about an agent returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.get_fleet_agent_info".to_sym] = true
end
api_instance = DatadogAPIClient::V2::FleetAutomationAPI.new
p api_instance.get_fleet_agent_info("agent_key")

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Get detailed information about an agent 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.GetFleetAgentInfo", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewFleetAutomationApi(apiClient)
	resp, r, err := api.GetFleetAgentInfo(ctx, "agent_key")

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FleetAutomationApi.GetFleetAgentInfo`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `FleetAutomationApi.GetFleetAgentInfo`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Get detailed information about an agent 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.FleetAgentInfoResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.getFleetAgentInfo", true);
    FleetAutomationApi apiInstance = new FleetAutomationApi(defaultClient);

    try {
      FleetAgentInfoResponse result = apiInstance.getFleetAgentInfo("agent_key");
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling FleetAutomationApi#getFleetAgentInfo");
      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 and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
// Get detailed information about an agent returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_fleet_automation::FleetAutomationAPI;

#[tokio::main]
async fn main() {
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.GetFleetAgentInfo", true);
    let api = FleetAutomationAPI::with_config(configuration);
    let resp = api.get_fleet_agent_info("agent_key".to_string()).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
 * Get detailed information about an agent returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.getFleetAgentInfo"] = true;
const apiInstance = new v2.FleetAutomationApi(configuration);

const params: v2.FleetAutomationApiGetFleetAgentInfoRequest = {
  agentKey: "agent_key",
};

apiInstance
  .getFleetAgentInfo(params)
  .then((data: v2.FleetAgentInfoResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"