Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 US1-FED

CSM Agents

Datadog Cloud Security Management (CSM) delivers real-time threat detection and continuous configuration audits across your entire cloud infrastructure, all in a unified view for seamless collaboration and faster remediation. Go to https://docs.datadoghq.com/security/cloud_security_management to learn more

Get all CSM Agents

GET https://api.ap1.datadoghq.com/api/v2/csm/onboarding/agentshttps://api.datadoghq.eu/api/v2/csm/onboarding/agentshttps://api.ddog-gov.com/api/v2/csm/onboarding/agentshttps://api.datadoghq.com/api/v2/csm/onboarding/agentshttps://api.us3.datadoghq.com/api/v2/csm/onboarding/agentshttps://api.us5.datadoghq.com/api/v2/csm/onboarding/agents

Overview

Get the list of all CSM Agents running on your hosts and containers.

Arguments

Query Strings

Name

Type

Description

page

integer

The page index for pagination (zero-based).

size

integer

The number of items to include in a single page.

query

string

A search query string to filter results (for example, hostname:COMP-T2H4J27423).

order_direction

enum

The sort direction for results. Use asc for ascending or desc for descending.
Allowed enum values: asc, desc

Response

OK

Response object that includes a list of CSM Agents.

Expand All

Field

Type

Description

data

[object]

A list of Agents.

attributes

object

A CSM Agent returned by the API.

agent_version

string

Version of the Datadog Agent.

aws_fargate

string

AWS Fargate details.

cluster_name

[string]

List of cluster names associated with the Agent.

datadog_agent

string

Unique identifier for the Datadog Agent.

ecs_fargate_task_arn

string

ARN of the ECS Fargate task.

envs

[string]

List of environments associated with the Agent.

host_id

int64

ID of the host.

hostname

string

Name of the host.

install_method_installer_version

string

Version of the installer used for installing the Datadog Agent.

install_method_tool

string

Tool used for installing the Datadog Agent.

is_csm_vm_containers_enabled

boolean

Indicates if CSM VM Containers is enabled.

is_csm_vm_hosts_enabled

boolean

Indicates if CSM VM Hosts is enabled.

is_cspm_enabled

boolean

Indicates if CSPM is enabled.

is_cws_enabled

boolean

Indicates if CWS is enabled.

is_cws_remote_configuration_enabled

boolean

Indicates if CWS Remote Configuration is enabled.

is_remote_configuration_enabled

boolean

Indicates if Remote Configuration is enabled.

os

string

Operating system of the host.

id

string

The ID of the Agent.

type

enum

The type of the resource. The value should always be datadog_agent. Allowed enum values: datadog_agent

default: datadog_agent

meta

object

Metadata related to the paginated response.

page_index

int64

The index of the current page in the paginated results.

page_size

int64

The number of items per page in the paginated results.

total_filtered

int64

Total number of items that match the filter criteria.

{
  "data": [
    {
      "attributes": {
        "agent_version": "string",
        "aws_fargate": "string",
        "cluster_name": [],
        "datadog_agent": "string",
        "ecs_fargate_task_arn": "string",
        "envs": [],
        "host_id": "integer",
        "hostname": "string",
        "install_method_installer_version": "string",
        "install_method_tool": "string",
        "is_csm_vm_containers_enabled": false,
        "is_csm_vm_hosts_enabled": false,
        "is_cspm_enabled": false,
        "is_cws_enabled": false,
        "is_cws_remote_configuration_enabled": false,
        "is_remote_configuration_enabled": false,
        "os": "string"
      },
      "id": "fffffc5505f6a006fdf7cf5aae053653",
      "type": "datadog_agent"
    }
  ],
  "meta": {
    "page_index": 0,
    "page_size": 10,
    "total_filtered": 128697
  }
}

Not Authorized

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

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/csm/onboarding/agents" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Get all CSM Serverless Agents

GET https://api.ap1.datadoghq.com/api/v2/csm/onboarding/serverless/agentshttps://api.datadoghq.eu/api/v2/csm/onboarding/serverless/agentshttps://api.ddog-gov.com/api/v2/csm/onboarding/serverless/agentshttps://api.datadoghq.com/api/v2/csm/onboarding/serverless/agentshttps://api.us3.datadoghq.com/api/v2/csm/onboarding/serverless/agentshttps://api.us5.datadoghq.com/api/v2/csm/onboarding/serverless/agents

Overview

Get the list of all CSM Serverless Agents running on your hosts and containers.

Arguments

Query Strings

Name

Type

Description

page

integer

The page index for pagination (zero-based).

size

integer

The number of items to include in a single page.

query

string

A search query string to filter results (for example, hostname:COMP-T2H4J27423).

order_direction

enum

The sort direction for results. Use asc for ascending or desc for descending.
Allowed enum values: asc, desc

Response

OK

Response object that includes a list of CSM Agents.

Expand All

Field

Type

Description

data

[object]

A list of Agents.

attributes

object

A CSM Agent returned by the API.

agent_version

string

Version of the Datadog Agent.

aws_fargate

string

AWS Fargate details.

cluster_name

[string]

List of cluster names associated with the Agent.

datadog_agent

string

Unique identifier for the Datadog Agent.

ecs_fargate_task_arn

string

ARN of the ECS Fargate task.

envs

[string]

List of environments associated with the Agent.

host_id

int64

ID of the host.

hostname

string

Name of the host.

install_method_installer_version

string

Version of the installer used for installing the Datadog Agent.

install_method_tool

string

Tool used for installing the Datadog Agent.

is_csm_vm_containers_enabled

boolean

Indicates if CSM VM Containers is enabled.

is_csm_vm_hosts_enabled

boolean

Indicates if CSM VM Hosts is enabled.

is_cspm_enabled

boolean

Indicates if CSPM is enabled.

is_cws_enabled

boolean

Indicates if CWS is enabled.

is_cws_remote_configuration_enabled

boolean

Indicates if CWS Remote Configuration is enabled.

is_remote_configuration_enabled

boolean

Indicates if Remote Configuration is enabled.

os

string

Operating system of the host.

id

string

The ID of the Agent.

type

enum

The type of the resource. The value should always be datadog_agent. Allowed enum values: datadog_agent

default: datadog_agent

meta

object

Metadata related to the paginated response.

page_index

int64

The index of the current page in the paginated results.

page_size

int64

The number of items per page in the paginated results.

total_filtered

int64

Total number of items that match the filter criteria.

{
  "data": [
    {
      "attributes": {
        "agent_version": "string",
        "aws_fargate": "string",
        "cluster_name": [],
        "datadog_agent": "string",
        "ecs_fargate_task_arn": "string",
        "envs": [],
        "host_id": "integer",
        "hostname": "string",
        "install_method_installer_version": "string",
        "install_method_tool": "string",
        "is_csm_vm_containers_enabled": false,
        "is_csm_vm_hosts_enabled": false,
        "is_cspm_enabled": false,
        "is_cws_enabled": false,
        "is_cws_remote_configuration_enabled": false,
        "is_remote_configuration_enabled": false,
        "os": "string"
      },
      "id": "fffffc5505f6a006fdf7cf5aae053653",
      "type": "datadog_agent"
    }
  ],
  "meta": {
    "page_index": 0,
    "page_size": 10,
    "total_filtered": 128697
  }
}

Not Authorized

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

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/csm/onboarding/serverless/agents" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"