csm_agents

Creates, updates, deletes, gets or lists a csm_agents resource.

Overview

Name	csm_agents
Type	Resource
Id	datadog.security.csm_agents

Fields

The following fields are returned by SELECT queries:

list_all_csmagents

Name	Datatype	Description
id	string	The ID of the Agent. (example: fffffc5505f6a006fdf7cf5aae053653)
attributes	object	A CSM Agent returned by the API.
type	string	The type of the resource. The value should always be datadog_agent. (default: datadog_agent, example: datadog_agent)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_all_csmagents	select	region	page, size, query, order_direction	Get the list of all CSM Agents running on your hosts and containers.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	(default: datadoghq.com)
order_direction	string	The sort direction for results. Use asc for ascending or desc for descending.
page	integer (int32)	The page index for pagination (zero-based).
query	string	A search query string to filter results (for example, hostname:COMP-T2H4J27423).
size	integer (int32)	The number of items to include in a single page.

SELECT examples

list_all_csmagents

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

SELECT
id,
attributes,
type
FROM datadog.security.csm_agents
WHERE region = '{{ region }}' -- required
AND page = '{{ page }}'
AND size = '{{ size }}'
AND query = '{{ query }}'
AND order_direction = '{{ order_direction }}'
;