Skip to content

Commit 4a803e8

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add CSM Agents Read Endpoint (#1955)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 93b3a0f commit 4a803e8

File tree

22 files changed

+1285
-12
lines changed

22 files changed

+1285
-12
lines changed

‎.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2024-12-16 18:27:54.516373",
8-
"spec_repo_commit": "a179b579"
7+
"regenerated": "2024-12-16 19:15:39.884123",
8+
"spec_repo_commit": "162aece5"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-12-16 18:27:54.536061",
13-
"spec_repo_commit": "a179b579"
12+
"regenerated": "2024-12-16 19:15:39.898938",
13+
"spec_repo_commit": "162aece5"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

Lines changed: 244 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4339,6 +4339,34 @@ components:
43394339
from the other indexes
43404340
type: string
43414341
type: object
4342+
CSMAgentsMetadata:
4343+
description: Metadata related to the paginated response.
4344+
properties:
4345+
page_index:
4346+
description: The index of the current page in the paginated results.
4347+
example: 0
4348+
format: int64
4349+
type: integer
4350+
page_size:
4351+
description: The number of items per page in the paginated results.
4352+
example: 10
4353+
format: int64
4354+
type: integer
4355+
total_filtered:
4356+
description: Total number of items that match the filter criteria.
4357+
example: 128697
4358+
format: int64
4359+
type: integer
4360+
type: object
4361+
CSMAgentsType:
4362+
default: datadog_agent
4363+
description: The type of the resource. The value should always be `datadog_agent`.
4364+
enum:
4365+
- datadog_agent
4366+
example: datadog_agent
4367+
type: string
4368+
x-enum-varnames:
4369+
- DATADOG_AGENT
43424370
CalculatedField:
43434371
description: Calculated field.
43444372
properties:
@@ -6630,6 +6658,96 @@ components:
66306658
nullable: true
66316659
type: string
66326660
type: object
6661+
CsmAgentData:
6662+
description: Single Agent Data.
6663+
properties:
6664+
attributes:
6665+
$ref: '#/components/schemas/CsmAgentsAttributes'
6666+
id:
6667+
description: The ID of the Agent.
6668+
example: fffffc5505f6a006fdf7cf5aae053653
6669+
type: string
6670+
type:
6671+
$ref: '#/components/schemas/CSMAgentsType'
6672+
type: object
6673+
CsmAgentsAttributes:
6674+
description: A CSM Agent returned by the API.
6675+
properties:
6676+
agent_version:
6677+
description: Version of the Datadog Agent.
6678+
type: string
6679+
aws_fargate:
6680+
description: AWS Fargate details.
6681+
type: string
6682+
cluster_name:
6683+
description: List of cluster names associated with the Agent.
6684+
items:
6685+
type: string
6686+
type: array
6687+
datadog_agent:
6688+
description: Unique identifier for the Datadog Agent.
6689+
type: string
6690+
ecs_fargate_task_arn:
6691+
description: ARN of the ECS Fargate task.
6692+
type: string
6693+
envs:
6694+
description: List of environments associated with the Agent.
6695+
items:
6696+
type: string
6697+
nullable: true
6698+
type: array
6699+
host_id:
6700+
description: ID of the host.
6701+
format: int64
6702+
type: integer
6703+
hostname:
6704+
description: Name of the host.
6705+
type: string
6706+
install_method_installer_version:
6707+
description: Version of the installer used for installing the Datadog Agent.
6708+
type: string
6709+
install_method_tool:
6710+
description: Tool used for installing the Datadog Agent.
6711+
type: string
6712+
is_csm_vm_containers_enabled:
6713+
description: Indicates if CSM VM Containers is enabled.
6714+
nullable: true
6715+
type: boolean
6716+
is_csm_vm_hosts_enabled:
6717+
description: Indicates if CSM VM Hosts is enabled.
6718+
nullable: true
6719+
type: boolean
6720+
is_cspm_enabled:
6721+
description: Indicates if CSPM is enabled.
6722+
nullable: true
6723+
type: boolean
6724+
is_cws_enabled:
6725+
description: Indicates if CWS is enabled.
6726+
nullable: true
6727+
type: boolean
6728+
is_cws_remote_configuration_enabled:
6729+
description: Indicates if CWS Remote Configuration is enabled.
6730+
nullable: true
6731+
type: boolean
6732+
is_remote_configuration_enabled:
6733+
description: Indicates if Remote Configuration is enabled.
6734+
nullable: true
6735+
type: boolean
6736+
os:
6737+
description: Operating system of the host.
6738+
type: string
6739+
type: object
6740+
CsmAgentsResponse:
6741+
description: Response object that includes a list of CSM Agents.
6742+
properties:
6743+
data:
6744+
description: A list of Agents.
6745+
items:
6746+
$ref: '#/components/schemas/CsmAgentData'
6747+
type: array
6748+
meta:
6749+
$ref: '#/components/schemas/CSMAgentsMetadata'
6750+
type: object
66336751
CustomCostGetResponseMeta:
66346752
description: Meta for the response from the Get Custom Costs endpoints.
66356753
properties:
@@ -17704,6 +17822,16 @@ components:
1770417822
required:
1770517823
- data
1770617824
type: object
17825+
OrderDirection:
17826+
description: The sort direction for results.
17827+
enum:
17828+
- asc
17829+
- desc
17830+
example: asc
17831+
type: string
17832+
x-enum-varnames:
17833+
- ASC
17834+
- DESC
1770717835
OrgConfigGetResponse:
1770817836
description: A response with a single Org Config.
1770917837
properties:
@@ -30922,6 +31050,113 @@ paths:
3092231050
x-unstable: '**Note**: This endpoint is in public beta.
3092331051

3092431052
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
31053+
/api/v2/csm/onboarding/agents:
31054+
get:
31055+
description: Get the list of all CSM Agents running on your hosts and containers.
31056+
operationId: ListAllCSMAgents
31057+
parameters:
31058+
- description: The page index for pagination (zero-based).
31059+
in: query
31060+
name: page
31061+
required: false
31062+
schema:
31063+
example: 2
31064+
format: int32
31065+
maximum: 1000000
31066+
minimum: 0
31067+
type: integer
31068+
- description: The number of items to include in a single page.
31069+
in: query
31070+
name: size
31071+
required: false
31072+
schema:
31073+
example: 12
31074+
format: int32
31075+
maximum: 100
31076+
minimum: 0
31077+
type: integer
31078+
- description: A search query string to filter results (for example, `hostname:COMP-T2H4J27423`).
31079+
in: query
31080+
name: query
31081+
required: false
31082+
schema:
31083+
example: hostname:COMP-T2H4J27423
31084+
type: string
31085+
- description: The sort direction for results. Use `asc` for ascending or `desc`
31086+
for descending.
31087+
in: query
31088+
name: order_direction
31089+
required: false
31090+
schema:
31091+
$ref: '#/components/schemas/OrderDirection'
31092+
responses:
31093+
'200':
31094+
content:
31095+
application/json:
31096+
schema:
31097+
$ref: '#/components/schemas/CsmAgentsResponse'
31098+
description: OK
31099+
'403':
31100+
$ref: '#/components/responses/NotAuthorizedResponse'
31101+
'429':
31102+
$ref: '#/components/responses/TooManyRequestsResponse'
31103+
summary: Get all CSM Agents
31104+
tags:
31105+
- CSM Agents
31106+
/api/v2/csm/onboarding/serverless/agents:
31107+
get:
31108+
description: Get the list of all CSM Serverless Agents running on your hosts
31109+
and containers.
31110+
operationId: ListAllCSMServerlessAgents
31111+
parameters:
31112+
- description: The page index for pagination (zero-based).
31113+
in: query
31114+
name: page
31115+
required: false
31116+
schema:
31117+
example: 2
31118+
format: int32
31119+
maximum: 1000000
31120+
minimum: 0
31121+
type: integer
31122+
- description: The number of items to include in a single page.
31123+
in: query
31124+
name: size
31125+
required: false
31126+
schema:
31127+
example: 12
31128+
format: int32
31129+
maximum: 100
31130+
minimum: 0
31131+
type: integer
31132+
- description: A search query string to filter results (for example, `hostname:COMP-T2H4J27423`).
31133+
in: query
31134+
name: query
31135+
required: false
31136+
schema:
31137+
example: hostname:COMP-T2H4J27423
31138+
type: string
31139+
- description: The sort direction for results. Use `asc` for ascending or `desc`
31140+
for descending.
31141+
in: query
31142+
name: order_direction
31143+
required: false
31144+
schema:
31145+
$ref: '#/components/schemas/OrderDirection'
31146+
responses:
31147+
'200':
31148+
content:
31149+
application/json:
31150+
schema:
31151+
$ref: '#/components/schemas/CsmAgentsResponse'
31152+
description: OK
31153+
'403':
31154+
$ref: '#/components/responses/NotAuthorizedResponse'
31155+
'429':
31156+
$ref: '#/components/responses/TooManyRequestsResponse'
31157+
summary: Get all CSM Serverless Agents
31158+
tags:
31159+
- CSM Agents
3092531160
/api/v2/current_user/application_keys:
3092631161
get:
3092731162
description: List all application keys available for current user
@@ -44624,6 +44859,15 @@ tags:
4462444859
[Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more
4462544860
information.
4462644861
name: CI Visibility Tests
44862+
- description: 'Datadog Cloud Security Management (CSM) delivers real-time threat
44863+
detection
44864+
44865+
and continuous configuration audits across your entire cloud infrastructure,
44866+
44867+
all in a unified view for seamless collaboration and faster remediation.
44868+
44869+
Go to https://docs.datadoghq.com/security/cloud_security_management to learn more'
44870+
name: CSM Agents
4462744871
- description: Cloud Security Management Threats (CSM Threats) monitors file, network,
4462844872
and process activity across your environment to detect real-time threats to your
4462944873
infrastructure. See [Cloud Security Management Threats](https://docs.datadoghq.com/security/threats/)

‎cassettes/v2/CSM-Agents_3304762456/Get-all-CSM-Agents-returns-OK-response_1277052251/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-12-13T17:22:57.344Z"

‎cassettes/v2/CSM-Agents_3304762456/Get-all-CSM-Agents-returns-OK-response_1277052251/recording.har

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{
2+
"log": {
3+
"_recordingName": "CSM Agents/Get all CSM Agents returns \"OK\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "cf844fd90c62518336473aebfc1fbf5e",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 0,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
}
23+
],
24+
"headersSize": 518,
25+
"httpVersion": "HTTP/1.1",
26+
"method": "GET",
27+
"queryString": [],
28+
"url": "https://api.datadoghq.com/api/v2/csm/onboarding/agents"
29+
},
30+
"response": {
31+
"bodySize": 5745,
32+
"content": {
33+
"mimeType": "application/vnd.api+json",
34+
"size": 5745,
35+
"text": "{\"data\":[{\"id\":\"f3087801a44eba3c2ea706e873aee9e4\",\"type\":\"datadog_agent\",\"attributes\":{\"agent_version\":\"7.59.1\",\"aws_fargate\":\"\",\"cluster_name\":[\"\"],\"ecs_fargate_task_arn\":\"\",\"envs\":[\"pcf-vane-3512666\"],\"host_id\":29630727754,\"hostname\":\"datadog-cluster-agent-0-af63a3e6-4a25-4def-83a4-8754d185b3ef\",\"install_method_installer_version\":\"\",\"install_method_tool\":\"undefined\",\"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\":true,\"is_remote_configuration_enabled\":true,\"os\":\"GNU/Linux\"}},{\"id\":\"d66d3bc7b9d4273183431b501ef33d86\",\"type\":\"datadog_agent\",\"attributes\":{\"agent_version\":\"7.59.1\",\"aws_fargate\":\"\",\"cluster_name\":[\"\"],\"ecs_fargate_task_arn\":\"\",\"envs\":[\"pcf-vane-3512666\"],\"host_id\":29623236313,\"hostname\":\"database-0-e7b70a7b-4199-4920-a8e3-62f221819522\",\"install_method_installer_version\":\"\",\"install_method_tool\":\"undefined\",\"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\":true,\"is_remote_configuration_enabled\":true,\"os\":\"GNU/Linux\"}},{\"id\":\"c8eca433902d29dd748f93e413eb2a9d\",\"type\":\"datadog_agent\",\"attributes\":{\"agent_version\":\"7.59.1\",\"aws_fargate\":\"\",\"cluster_name\":[\"\"],\"ecs_fargate_task_arn\":\"\",\"envs\":[\"pcf-farm-3522782\"],\"host_id\":29722803807,\"hostname\":\"router-0-1bf8fdd0-bbc2-4cf3-8c7c-c1605bafa9bd\",\"install_method_installer_version\":\"\",\"install_method_tool\":\"undefined\",\"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\":true,\"is_remote_configuration_enabled\":true,\"os\":\"GNU/Linux\"}},{\"id\":\"c6009fcea425da0722eeefd58d95ae6e\",\"type\":\"datadog_agent\",\"attributes\":{\"agent_version\":\"7.59.1\",\"aws_fargate\":\"\",\"cluster_name\":[\"\"],\"ecs_fargate_task_arn\":\"\",\"envs\":[\"pcf-vane-3512666\"],\"host_id\":29623808723,\"hostname\":\"compute-0-abf8a42e-5338-44e5-8048-658415893f3c\",\"install_method_installer_version\":\"\",\"install_method_tool\":\"undefined\",\"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\":true,\"is_remote_configuration_enabled\":true,\"os\":\"GNU/Linux\"}},{\"id\":\"b5684ca6ace0e5eb757124a1bce8ad13\",\"type\":\"datadog_agent\",\"attributes\":{\"agent_version\":\"7.59.1\",\"aws_fargate\":\"\",\"cluster_name\":[\"\"],\"ecs_fargate_task_arn\":\"\",\"envs\":[\"pcf-nook-3513764\"],\"host_id\":29671027855,\"hostname\":\"database-0-805a7570-d3cf-4acc-97d8-c40ac88df896\",\"install_method_installer_version\":\"\",\"install_method_tool\":\"undefined\",\"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\":true,\"is_remote_configuration_enabled\":true,\"os\":\"GNU/Linux\"}},{\"id\":\"b2432c7f30596064f765d9f2b400299e\",\"type\":\"datadog_agent\",\"attributes\":{\"agent_version\":\"7.59.1\",\"aws_fargate\":\"\",\"cluster_name\":[\"\"],\"ecs_fargate_task_arn\":\"\",\"envs\":[\"pcf-vane-3512666\"],\"host_id\":29623289233,\"hostname\":\"blobstore-0-2d6429ae-61a4-4d6d-a1be-1e6c20711d62\",\"install_method_installer_version\":\"\",\"install_method_tool\":\"undefined\",\"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\":true,\"is_remote_configuration_enabled\":true,\"os\":\"GNU/Linux\"}},{\"id\":\"b18cbc65f97d10e2db319de9664e8136\",\"type\":\"datadog_agent\",\"attributes\":{\"agent_version\":\"7.59.1\",\"aws_fargate\":\"\",\"cluster_name\":[\"\"],\"ecs_fargate_task_arn\":\"\",\"envs\":[\"pcf-vane-3512666\"],\"host_id\":29623905136,\"hostname\":\"router-0-f84247ea-89db-459f-8db9-e19faaf118b9\",\"install_method_installer_version\":\"\",\"install_method_tool\":\"undefined\",\"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\":true,\"is_remote_configuration_enabled\":true,\"os\":\"GNU/Linux\"}},{\"id\":\"a99fccb5f6f726754282ea7ff84269c3\",\"type\":\"datadog_agent\",\"attributes\":{\"agent_version\":\"7.62.0-devel+git.319.c819811\",\"aws_fargate\":\"\",\"cluster_name\":[\"\"],\"ecs_fargate_task_arn\":\"\",\"envs\":null,\"host_id\":15240413136,\"hostname\":\"comp-xctp773fw9\",\"install_method_installer_version\":\"docker\",\"install_method_tool\":\"docker\",\"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\":true,\"is_remote_configuration_enabled\":true,\"os\":\"GNU/Linux\"}},{\"id\":\"a57d21e013a51ea0a3881ad7d4f1d7d1\",\"type\":\"datadog_agent\",\"attributes\":{\"agent_version\":\"7.59.1\",\"aws_fargate\":\"\",\"cluster_name\":[\"\"],\"ecs_fargate_task_arn\":\"\",\"envs\":[\"pcf-vane-3512666\"],\"host_id\":29630585934,\"hostname\":\"datadog-firehose-nozzle-0-d3f355d3-2839-441d-884b-9e7ee6c248a6\",\"install_method_installer_version\":\"\",\"install_method_tool\":\"undefined\",\"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\":true,\"is_remote_configuration_enabled\":true,\"os\":\"GNU/Linux\"}},{\"id\":\"a43d2a3241ca97359058507a36800089\",\"type\":\"datadog_agent\",\"attributes\":{\"agent_version\":\"7.59.1\",\"aws_fargate\":\"\",\"cluster_name\":[\"\"],\"ecs_fargate_task_arn\":\"\",\"envs\":[\"pcf-nook-3513764\"],\"host_id\":29700921282,\"hostname\":\"datadog-firehose-nozzle-0-451fe766-caa2-4fb7-9198-076d2e1ef872\",\"install_method_installer_version\":\"\",\"install_method_tool\":\"undefined\",\"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\":true,\"is_remote_configuration_enabled\":true,\"os\":\"GNU/Linux\"}}],\"meta\":{\"total_filtered\":24,\"page_index\":0,\"page_size\":10}}"
36+
},
37+
"cookies": [],
38+
"headers": [
39+
{
40+
"name": "content-type",
41+
"value": "application/vnd.api+json"
42+
}
43+
],
44+
"headersSize": 532,
45+
"httpVersion": "HTTP/1.1",
46+
"redirectURL": "",
47+
"status": 200,
48+
"statusText": "OK"
49+
},
50+
"startedDateTime": "2024-12-13T17:22:57.553Z",
51+
"time": 211
52+
}
53+
],
54+
"pages": [],
55+
"version": "1.2"
56+
}
57+
}

‎cassettes/v2/CSM-Agents_3304762456/Get-all-CSM-Serverless-Agents-returns-OK-response_2700046291/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-12-13T17:22:57.772Z"

0 commit comments

Comments
 (0)