Skip to content

Commit 1d711d0

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add CSM Coverage Analysis API specs (#1970)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 7256f9a commit 1d711d0

27 files changed

+1587
-4
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": "2025-01-02 14:39:42.082975",
8-
"spec_repo_commit": "b4e964b3"
7+
"regenerated": "2025-01-02 15:18:20.432882",
8+
"spec_repo_commit": "bc53c28f"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-01-02 14:39:42.099534",
13-
"spec_repo_commit": "b4e964b3"
12+
"regenerated": "2025-01-02 15:18:20.447693",
13+
"spec_repo_commit": "bc53c28f"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

Lines changed: 209 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7340,6 +7340,140 @@ components:
73407340
meta:
73417341
$ref: '#/components/schemas/CSMAgentsMetadata'
73427342
type: object
7343+
CsmCloudAccountsCoverageAnalysisAttributes:
7344+
description: CSM Cloud Accounts Coverage Analysis attributes.
7345+
properties:
7346+
aws_coverage:
7347+
$ref: '#/components/schemas/CsmCoverageAnalysis'
7348+
azure_coverage:
7349+
$ref: '#/components/schemas/CsmCoverageAnalysis'
7350+
gcp_coverage:
7351+
$ref: '#/components/schemas/CsmCoverageAnalysis'
7352+
org_id:
7353+
description: The ID of your organization.
7354+
example: 123456
7355+
format: int64
7356+
type: integer
7357+
total_coverage:
7358+
$ref: '#/components/schemas/CsmCoverageAnalysis'
7359+
type: object
7360+
CsmCloudAccountsCoverageAnalysisData:
7361+
description: CSM Cloud Accounts Coverage Analysis data.
7362+
properties:
7363+
attributes:
7364+
$ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisAttributes'
7365+
id:
7366+
description: The ID of your organization.
7367+
example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3
7368+
type: string
7369+
type:
7370+
default: get_cloud_accounts_coverage_analysis_response_public_v0
7371+
description: The type of the resource. The value should always be `get_cloud_accounts_coverage_analysis_response_public_v0`.
7372+
example: get_cloud_accounts_coverage_analysis_response_public_v0
7373+
type: string
7374+
type: object
7375+
CsmCloudAccountsCoverageAnalysisResponse:
7376+
description: CSM Cloud Accounts Coverage Analysis response.
7377+
properties:
7378+
data:
7379+
$ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisData'
7380+
type: object
7381+
CsmCoverageAnalysis:
7382+
description: CSM Coverage Analysis.
7383+
properties:
7384+
configured_resources_count:
7385+
description: The number of fully configured resources.
7386+
example: 8
7387+
format: int64
7388+
type: integer
7389+
coverage:
7390+
description: The coverage percentage.
7391+
example: 0.8
7392+
format: double
7393+
type: number
7394+
partially_configured_resources_count:
7395+
description: The number of partially configured resources.
7396+
example: 0
7397+
format: int64
7398+
type: integer
7399+
total_resources_count:
7400+
description: The total number of resources.
7401+
example: 10
7402+
format: int64
7403+
type: integer
7404+
type: object
7405+
CsmHostsAndContainersCoverageAnalysisAttributes:
7406+
description: CSM Hosts and Containers Coverage Analysis attributes.
7407+
properties:
7408+
cspm_coverage:
7409+
$ref: '#/components/schemas/CsmCoverageAnalysis'
7410+
cws_coverage:
7411+
$ref: '#/components/schemas/CsmCoverageAnalysis'
7412+
org_id:
7413+
description: The ID of your organization.
7414+
example: 123456
7415+
format: int64
7416+
type: integer
7417+
total_coverage:
7418+
$ref: '#/components/schemas/CsmCoverageAnalysis'
7419+
vm_coverage:
7420+
$ref: '#/components/schemas/CsmCoverageAnalysis'
7421+
type: object
7422+
CsmHostsAndContainersCoverageAnalysisData:
7423+
description: CSM Hosts and Containers Coverage Analysis data.
7424+
properties:
7425+
attributes:
7426+
$ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisAttributes'
7427+
id:
7428+
description: The ID of your organization.
7429+
example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3
7430+
type: string
7431+
type:
7432+
default: get_hosts_and_containers_coverage_analysis_response_public_v0
7433+
description: The type of the resource. The value should always be `get_hosts_and_containers_coverage_analysis_response_public_v0`.
7434+
example: get_hosts_and_containers_coverage_analysis_response_public_v0
7435+
type: string
7436+
type: object
7437+
CsmHostsAndContainersCoverageAnalysisResponse:
7438+
description: CSM Hosts and Containers Coverage Analysis response.
7439+
properties:
7440+
data:
7441+
$ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisData'
7442+
type: object
7443+
CsmServerlessCoverageAnalysisAttributes:
7444+
description: CSM Serverless Resources Coverage Analysis attributes.
7445+
properties:
7446+
cws_coverage:
7447+
$ref: '#/components/schemas/CsmCoverageAnalysis'
7448+
org_id:
7449+
description: The ID of your organization.
7450+
example: 123456
7451+
format: int64
7452+
type: integer
7453+
total_coverage:
7454+
$ref: '#/components/schemas/CsmCoverageAnalysis'
7455+
type: object
7456+
CsmServerlessCoverageAnalysisData:
7457+
description: CSM Serverless Resources Coverage Analysis data.
7458+
properties:
7459+
attributes:
7460+
$ref: '#/components/schemas/CsmServerlessCoverageAnalysisAttributes'
7461+
id:
7462+
description: The ID of your organization.
7463+
example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3
7464+
type: string
7465+
type:
7466+
default: get_serverless_coverage_analysis_response_public_v0
7467+
description: The type of the resource. The value should always be `get_serverless_coverage_analysis_response_public_v0`.
7468+
example: get_serverless_coverage_analysis_response_public_v0
7469+
type: string
7470+
type: object
7471+
CsmServerlessCoverageAnalysisResponse:
7472+
description: CSM Serverless Resources Coverage Analysis response.
7473+
properties:
7474+
data:
7475+
$ref: '#/components/schemas/CsmServerlessCoverageAnalysisData'
7476+
type: object
73437477
CustomConnection:
73447478
description: The definition of `CustomConnection` object.
73457479
properties:
@@ -33610,6 +33744,72 @@ paths:
3361033744
summary: Get all CSM Agents
3361133745
tags:
3361233746
- CSM Agents
33747+
/api/v2/csm/onboarding/coverage_analysis/cloud_accounts:
33748+
get:
33749+
description: 'Get the CSM Coverage Analysis of your Cloud Accounts.
33750+
33751+
This is calculated based on the number of your Cloud Accounts that are
33752+
33753+
scanned for security issues.'
33754+
operationId: GetCSMCloudAccountsCoverageAnalysis
33755+
responses:
33756+
'200':
33757+
content:
33758+
application/json:
33759+
schema:
33760+
$ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisResponse'
33761+
description: OK
33762+
'403':
33763+
$ref: '#/components/responses/NotAuthorizedResponse'
33764+
'429':
33765+
$ref: '#/components/responses/TooManyRequestsResponse'
33766+
summary: Get the CSM Cloud Accounts Coverage Analysis
33767+
tags:
33768+
- CSM Coverage Analysis
33769+
/api/v2/csm/onboarding/coverage_analysis/hosts_and_containers:
33770+
get:
33771+
description: 'Get the CSM Coverage Analysis of your Hosts and Containers.
33772+
33773+
This is calculated based on the number of agents running on your Hosts
33774+
33775+
and Containers with CSM feature(s) enabled.'
33776+
operationId: GetCSMHostsAndContainersCoverageAnalysis
33777+
responses:
33778+
'200':
33779+
content:
33780+
application/json:
33781+
schema:
33782+
$ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisResponse'
33783+
description: OK
33784+
'403':
33785+
$ref: '#/components/responses/NotAuthorizedResponse'
33786+
'429':
33787+
$ref: '#/components/responses/TooManyRequestsResponse'
33788+
summary: Get the CSM Hosts and Containers Coverage Analysis
33789+
tags:
33790+
- CSM Coverage Analysis
33791+
/api/v2/csm/onboarding/coverage_analysis/serverless:
33792+
get:
33793+
description: 'Get the CSM Coverage Analysis of your Serverless Resources.
33794+
33795+
This is calculated based on the number of agents running on your Serverless
33796+
33797+
Resources with CSM feature(s) enabled.'
33798+
operationId: GetCSMServerlessCoverageAnalysis
33799+
responses:
33800+
'200':
33801+
content:
33802+
application/json:
33803+
schema:
33804+
$ref: '#/components/schemas/CsmServerlessCoverageAnalysisResponse'
33805+
description: OK
33806+
'403':
33807+
$ref: '#/components/responses/NotAuthorizedResponse'
33808+
'429':
33809+
$ref: '#/components/responses/TooManyRequestsResponse'
33810+
summary: Get the CSM Serverless Coverage Analysis
33811+
tags:
33812+
- CSM Coverage Analysis
3361333813
/api/v2/csm/onboarding/serverless/agents:
3361433814
get:
3361533815
description: Get the list of all CSM Serverless Agents running on your hosts
@@ -47941,6 +48141,15 @@ tags:
4794148141

4794248142
Go to https://docs.datadoghq.com/security/cloud_security_management to learn more'
4794348143
name: CSM Agents
48144+
- description: 'Datadog Cloud Security Management (CSM) delivers real-time threat
48145+
detection
48146+
48147+
and continuous configuration audits across your entire cloud infrastructure,
48148+
48149+
all in a unified view for seamless collaboration and faster remediation.
48150+
48151+
Go to https://docs.datadoghq.com/security/cloud_security_management to learn more.'
48152+
name: CSM Coverage Analysis
4794448153
- description: Cloud Security Management Threats (CSM Threats) monitors file, network,
4794548154
and process activity across your environment to detect real-time threats to your
4794648155
infrastructure. See [Cloud Security Management Threats](https://docs.datadoghq.com/security/threats/)

‎cassettes/v2/CSM-Coverage-Analysis_717494718/Get-the-CSM-Cloud-Accounts-Coverage-Analysis-returns-OK-response_2510629898/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-12-19T17:17:10.296Z"

‎cassettes/v2/CSM-Coverage-Analysis_717494718/Get-the-CSM-Cloud-Accounts-Coverage-Analysis-returns-OK-response_2510629898/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 Coverage Analysis/Get the CSM Cloud Accounts Coverage Analysis returns \"OK\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "f1570efe40b47cebfbcdace56479e8bc",
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": 563,
25+
"httpVersion": "HTTP/1.1",
26+
"method": "GET",
27+
"queryString": [],
28+
"url": "https://api.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/cloud_accounts"
29+
},
30+
"response": {
31+
"bodySize": 691,
32+
"content": {
33+
"mimeType": "application/vnd.api+json",
34+
"size": 691,
35+
"text": "{\"data\":{\"id\":\"4dee724d-00cc-11ea-a77b-570c9d03c6c5\",\"type\":\"get_cloud_accounts_coverage_analysis_response_public_v0\",\"attributes\":{\"aws_coverage\":{\"partially_configured_resources_count\":0,\"configured_resources_count\":4,\"total_resources_count\":10,\"coverage\":0.4},\"azure_coverage\":{\"partially_configured_resources_count\":0,\"configured_resources_count\":2,\"total_resources_count\":6,\"coverage\":0.3333333333333333},\"gcp_coverage\":{\"partially_configured_resources_count\":0,\"configured_resources_count\":2,\"total_resources_count\":4,\"coverage\":0.5},\"org_id\":321813,\"total_coverage\":{\"partially_configured_resources_count\":0,\"configured_resources_count\":8,\"total_resources_count\":20,\"coverage\":0.4}}}}"
36+
},
37+
"cookies": [],
38+
"headers": [
39+
{
40+
"name": "content-type",
41+
"value": "application/vnd.api+json"
42+
}
43+
],
44+
"headersSize": 525,
45+
"httpVersion": "HTTP/1.1",
46+
"redirectURL": "",
47+
"status": 200,
48+
"statusText": "OK"
49+
},
50+
"startedDateTime": "2024-12-19T17:17:10.491Z",
51+
"time": 205
52+
}
53+
],
54+
"pages": [],
55+
"version": "1.2"
56+
}
57+
}

‎cassettes/v2/CSM-Coverage-Analysis_717494718/Get-the-CSM-Hosts-and-Containers-Coverage-Analysis-returns-OK-response_1932535387/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-12-19T17:17:10.704Z"

‎cassettes/v2/CSM-Coverage-Analysis_717494718/Get-the-CSM-Hosts-and-Containers-Coverage-Analysis-returns-OK-response_1932535387/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 Coverage Analysis/Get the CSM Hosts and Containers Coverage Analysis returns \"OK\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "ac8b113561fd9c48abee7e0b772938dc",
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": 574,
25+
"httpVersion": "HTTP/1.1",
26+
"method": "GET",
27+
"queryString": [],
28+
"url": "https://api.datadoghq.com/api/v2/csm/onboarding/coverage_analysis/hosts_and_containers"
29+
},
30+
"response": {
31+
"bodySize": 657,
32+
"content": {
33+
"mimeType": "application/vnd.api+json",
34+
"size": 657,
35+
"text": "{\"data\":{\"id\":\"4dee724d-00cc-11ea-a77b-570c9d03c6c5\",\"type\":\"get_hosts_and_containers_coverage_analysis_response_public_v0\",\"attributes\":{\"cspm_coverage\":{\"partially_configured_resources_count\":0,\"configured_resources_count\":0,\"total_resources_count\":9,\"coverage\":0},\"cws_coverage\":{\"partially_configured_resources_count\":0,\"configured_resources_count\":0,\"total_resources_count\":9,\"coverage\":0},\"org_id\":321813,\"total_coverage\":{\"partially_configured_resources_count\":0,\"configured_resources_count\":0,\"total_resources_count\":9,\"coverage\":0},\"vm_coverage\":{\"partially_configured_resources_count\":0,\"configured_resources_count\":0,\"total_resources_count\":0}}}}"
36+
},
37+
"cookies": [],
38+
"headers": [
39+
{
40+
"name": "content-type",
41+
"value": "application/vnd.api+json"
42+
}
43+
],
44+
"headersSize": 525,
45+
"httpVersion": "HTTP/1.1",
46+
"redirectURL": "",
47+
"status": 200,
48+
"statusText": "OK"
49+
},
50+
"startedDateTime": "2024-12-19T17:17:10.707Z",
51+
"time": 524
52+
}
53+
],
54+
"pages": [],
55+
"version": "1.2"
56+
}
57+
}

‎cassettes/v2/CSM-Coverage-Analysis_717494718/Get-the-CSM-Serverless-Coverage-Analysis-returns-OK-response_2184424131/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-12-19T17:17:11.235Z"

0 commit comments

Comments
 (0)