Fleet Automation

Get detailed information about an agent

Retrieve detailed information about a specific Datadog Agent.

By default, only agent_infos is returned. Use the include query parameter to request additional data: integrations and/or configuration_files.

get/api/v2/fleet/agents/{agent_key}

Request

Path parameters

agent_keystring required

The unique identifier (Agent key) for the Datadog Agent. Must be a 32-character lowercase hexadecimal string.

Query parameters

includestring

Comma-separated list of additional fields to include in the response. Valid values are integrations and configuration_files. Omitting this parameter returns only agent_infos. Unrecognized values are silently ignored rather than causing an error.

Response

OK

Example response

{
  "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",
        "datadog_agent_key": "a1b2c3d4e5f67890a1b2c3d4e5f67890",
        "datadog_data_center": "us1",
        "ecs_fargate_cluster_name": "my-ecs-cluster",
        "ecs_fargate_task_arn": "arn:aws:ecs:us-east-1:123456789012:task/my-cluster/abc123",
        "hostname": "my-hostname",
        "install_method_installer_version": "1.2.3",
        "install_method_tool": "chef",
        "os": "linux",
        "os_version": "Ubuntu 20.04",
        "python_version": "3.9.5",
        "remote_agent_management": "enabled",
        "remote_config_status": "connected"
      },
      "integrations": {
        "configuration_files": [
          {
            "file_path": "/conf.d/postgres.d/postgres.yaml",
            "filename": "postgres.yaml"
          }
        ],
        "error_integrations": [
          {
            "data_type": "metrics",
            "type": "postgres"
          }
        ],
        "missing_integrations": [
          {
            "escaped_name": "postgresql",
            "prefix": "postgres"
          }
        ],
        "warning_integrations": [
          {
            "data_type": "metrics",
            "type": "postgres"
          }
        ],
        "working_integrations": [
          {
            "data_type": "metrics",
            "type": "postgres"
          }
        ]
      }
    },
    "id": "a1b2c3d4e5f67890a1b2c3d4e5f67890",
    "type": "agent"
  }
}

Changes

Changes to this operation have not been checked yet.