Skip to content

Commit 44d9c09

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Update public docs for CSM Enterprise and CSPM (#1325)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent b60b070 commit 44d9c09

File tree

16 files changed

+621
-116
lines changed

16 files changed

+621
-116
lines changed

‎.apigentools-info

+4-4
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": "2023-09-22 15:04:23.958502",
8-
"spec_repo_commit": "61ae9703"
7+
"regenerated": "2023-09-22 16:26:39.643849",
8+
"spec_repo_commit": "45270a3e"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2023-09-22 15:04:23.973644",
13-
"spec_repo_commit": "61ae9703"
12+
"regenerated": "2023-09-22 16:26:39.657830",
13+
"spec_repo_commit": "45270a3e"
1414
}
1515
}
1616
}

‎.generator/schemas/v1/openapi.yaml

+238-67
Large diffs are not rendered by default.

‎.generator/schemas/v2/openapi.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -27121,7 +27121,8 @@ paths:
2712127121

2712227122
`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,
2712327123

27124-
`cspm`, `custom_events`, `cws`, `dbm`, `fargate`,
27124+
`csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`,
27125+
`cws`, `dbm`, `fargate`,
2712527126

2712627127
`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`,
2712727128
`iot`,

‎cassettes/v1/Usage-Metering_938753175/Get-hourly-usage-for-CSM-Pro-returns-OK-response_2345085612/frozen.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2023-09-20T21:11:12.476Z"

‎cassettes/v1/Usage-Metering_938753175/Get-hourly-usage-for-CSM-Pro-returns-OK-response_2345085612/recording.har

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
{
2+
"log": {
3+
"_recordingName": "Usage Metering/Get hourly usage for CSM Pro returns \"OK\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "6784202580c0b49a9247e6b54ae734d1",
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;datetime-format=rfc3339"
22+
}
23+
],
24+
"headersSize": 591,
25+
"httpVersion": "HTTP/1.1",
26+
"method": "GET",
27+
"queryString": [
28+
{
29+
"name": "start_hr",
30+
"value": "2023-09-17T21:11:12.476Z"
31+
}
32+
],
33+
"url": "https://api.datadoghq.com/api/v1/usage/cspm?start_hr=2023-09-17T21%3A11%3A12.476Z"
34+
},
35+
"response": {
36+
"bodySize": 6852,
37+
"content": {
38+
"mimeType": "application/json",
39+
"size": 6852,
40+
"text": "{\"usage\":[{\"hour\":\"2023-09-17T21:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-17T22:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-17T23:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T00:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T01:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T02:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T03:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T04:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T05:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T06:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T07:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T08:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T09:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T10:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T11:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T12:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T13:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T14:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T15:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T16:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T17:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T18:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T19:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"},{\"hour\":\"2023-09-18T20:00:00+00:00\",\"region\":\"us\",\"host_count\":null,\"container_count\":null,\"aas_host_count\":null,\"aws_host_count\":null,\"gcp_host_count\":null,\"azure_host_count\":null,\"compliance_host_count\":null,\"org_name\":\"DD Integration Tests (321813)\",\"public_id\":\"fasjyydbcgwwc2uc\"}]}\n"
41+
},
42+
"cookies": [],
43+
"headers": [
44+
{
45+
"name": "content-type",
46+
"value": "application/json"
47+
}
48+
],
49+
"headersSize": 651,
50+
"httpVersion": "HTTP/1.1",
51+
"redirectURL": "",
52+
"status": 200,
53+
"statusText": "OK"
54+
},
55+
"startedDateTime": "2023-09-20T21:11:12.816Z",
56+
"time": 542
57+
}
58+
],
59+
"pages": [],
60+
"version": "1.2"
61+
}
62+
}

‎examples/v1/usage-metering/GetUsageCloudSecurityPostureManagement.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Get hourly usage for CSPM returns "OK" response
2+
* Get hourly usage for CSM Pro returns "OK" response
33
*/
44

55
import { client, v1 } from "@datadog/datadog-api-client";

‎features/v1/usage_metering.feature

+2-2
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,14 @@ Feature: Usage Metering
102102
Then the response status is 200 OK
103103

104104
@generated @skip @team:DataDog/red-zone-revenue-query
105-
Scenario: Get hourly usage for CSPM returns "Bad Request" response
105+
Scenario: Get hourly usage for CSM Pro returns "Bad Request" response
106106
Given new "GetUsageCloudSecurityPostureManagement" request
107107
And request contains "start_hr" parameter from "REPLACE.ME"
108108
When the request is sent
109109
Then the response status is 400 Bad Request
110110

111111
@team:DataDog/red-zone-revenue-query
112-
Scenario: Get hourly usage for CSPM returns "OK" response
112+
Scenario: Get hourly usage for CSM Pro returns "OK" response
113113
Given new "GetUsageCloudSecurityPostureManagement" request
114114
And request contains "start_hr" parameter with value "{{ timeISO('now - 3d') }}"
115115
When the request is sent

‎packages/datadog-api-client-v1/apis/UsageMeteringApi.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -5449,7 +5449,7 @@ export class UsageMeteringApi {
54495449
}
54505450

54515451
/**
5452-
* Get hourly usage for cloud security posture management (CSPM).
5452+
* Get hourly usage for cloud security management (CSM) pro.
54535453
* **Note:** hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.
54545454
* @param param The request object
54555455
*/

‎packages/datadog-api-client-v1/models/MonthlyUsageAttributionValues.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -91,19 +91,19 @@ export class MonthlyUsageAttributionValues {
9191
*/
9292
"containerUsage"?: number;
9393
/**
94-
* The percentage of CSPM container usage by tag(s).
94+
* The percentage of Cloud Security Management Pro container usage by tag(s).
9595
*/
9696
"cspmContainersPercentage"?: number;
9797
/**
98-
* The CSPM container usage by tag(s).
98+
* The Cloud Security Management Pro container usage by tag(s).
9999
*/
100100
"cspmContainersUsage"?: number;
101101
/**
102-
* The percentage of CSPM host usage by by tag(s).
102+
* The percentage of Cloud Security Management Pro host usage by tag(s).
103103
*/
104104
"cspmHostsPercentage"?: number;
105105
/**
106-
* The CSPM host usage by tag(s).
106+
* The Cloud Security Management Pro host usage by tag(s).
107107
*/
108108
"cspmHostsUsage"?: number;
109109
/**

‎packages/datadog-api-client-v1/models/UsageAttributionValues.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -67,19 +67,19 @@ export class UsageAttributionValues {
6767
*/
6868
"containerUsage"?: number;
6969
/**
70-
* The percentage of Cloud Security Posture Management container usage by tag(s)
70+
* The percentage of Cloud Security Management Pro container usage by tag(s)
7171
*/
7272
"cspmContainerPercentage"?: number;
7373
/**
74-
* The Cloud Security Posture Management container usage by tag(s)
74+
* The Cloud Security Management Pro container usage by tag(s)
7575
*/
7676
"cspmContainerUsage"?: number;
7777
/**
78-
* The percentage of Cloud Security Posture Management host usage by tag(s)
78+
* The percentage of Cloud Security Management Pro host usage by tag(s)
7979
*/
8080
"cspmHostPercentage"?: number;
8181
/**
82-
* The Cloud Security Posture Management host usage by tag(s)
82+
* The Cloud Security Management Pro host usage by tag(s)
8383
*/
8484
"cspmHostUsage"?: number;
8585
/**

‎packages/datadog-api-client-v1/models/UsageCloudSecurityPostureManagementHour.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,35 @@
77
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
88

99
/**
10-
* Cloud Security Posture Management usage for a given organization for a given hour.
10+
* Cloud Security Management Pro usage for a given organization for a given hour.
1111
*/
1212
export class UsageCloudSecurityPostureManagementHour {
1313
/**
14-
* The number of Cloud Security Posture Management Azure app services hosts during a given hour.
14+
* The number of Cloud Security Management Pro Azure app services hosts during a given hour.
1515
*/
1616
"aasHostCount"?: number;
1717
/**
18-
* The number of Cloud Security Posture Management AWS hosts during a given hour.
18+
* The number of Cloud Security Management Pro AWS hosts during a given hour.
1919
*/
2020
"awsHostCount"?: number;
2121
/**
22-
* The number of Cloud Security Posture Management Azure hosts during a given hour.
22+
* The number of Cloud Security Management Pro Azure hosts during a given hour.
2323
*/
2424
"azureHostCount"?: number;
2525
/**
26-
* The number of Cloud Security Posture Management hosts during a given hour.
26+
* The number of Cloud Security Management Pro hosts during a given hour.
2727
*/
2828
"complianceHostCount"?: number;
2929
/**
30-
* The total number of Cloud Security Posture Management containers during a given hour.
30+
* The total number of Cloud Security Management Pro containers during a given hour.
3131
*/
3232
"containerCount"?: number;
3333
/**
34-
* The number of Cloud Security Posture Management GCP hosts during a given hour.
34+
* The number of Cloud Security Management Pro GCP hosts during a given hour.
3535
*/
3636
"gcpHostCount"?: number;
3737
/**
38-
* The total number of Cloud Security Posture Management hosts during a given hour.
38+
* The total number of Cloud Security Management Pro hosts during a given hour.
3939
*/
4040
"hostCount"?: number;
4141
/**

‎packages/datadog-api-client-v1/models/UsageCloudSecurityPostureManagementResponse.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ import { UsageCloudSecurityPostureManagementHour } from "./UsageCloudSecurityPos
88
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
99

1010
/**
11-
* The response containing the Cloud Security Posture Management usage for each hour for a given organization.
11+
* The response containing the Cloud Security Management Pro usage for each hour for a given organization.
1212
*/
1313
export class UsageCloudSecurityPostureManagementResponse {
1414
/**
15-
* Get hourly usage for Cloud Security Posture Management.
15+
* Get hourly usage for Cloud Security Management Pro.
1616
*/
1717
"usage"?: Array<UsageCloudSecurityPostureManagementHour>;
1818

0 commit comments

Comments
 (0)