Skip to content

Commit 3055ab9

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 20e4c2b of spec repo
1 parent 4d09c66 commit 3055ab9

9 files changed

+90
-33
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 68 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -62234,19 +62234,23 @@ components:
6223462234
- DONE
6223562235
- TIMEOUT
6223662236
SecurityMonitoringContentPackActivation:
62237-
description: The activation status of a content pack
62237+
description: The activation status of a content pack.
6223862238
enum:
6223962239
- never_activated
6224062240
- activated
6224162241
- deactivated
6224262242
example: activated
6224362243
type: string
62244+
x-enum-descriptions:
62245+
- Pack has never been activated for this organization.
62246+
- Pack is currently activated.
62247+
- Pack was previously activated but has since been deactivated.
6224462248
x-enum-varnames:
6224562249
- NEVER_ACTIVATED
6224662250
- ACTIVATED
6224762251
- DEACTIVATED
6224862252
SecurityMonitoringContentPackIntegrationStatus:
62249-
description: The installation status of the related integration
62253+
description: The installation status of the related integration.
6225062254
enum:
6225162255
- installed
6225262256
- available
@@ -62255,6 +62259,12 @@ components:
6225562259
- error
6225662260
example: installed
6225762261
type: string
62262+
x-enum-descriptions:
62263+
- Integration is fully installed.
62264+
- Integration exists in the catalog but is not installed.
62265+
- Integration is only partially configured.
62266+
- Integration detected (for example, logs are flowing) but not explicitly installed.
62267+
- Integration is in an error state.
6225862268
x-enum-varnames:
6225962269
- INSTALLED
6226062270
- AVAILABLE
@@ -62271,15 +62281,17 @@ components:
6227162281
cp_activation:
6227262282
$ref: "#/components/schemas/SecurityMonitoringContentPackActivation"
6227362283
filters_configured_for_logs:
62274-
description: Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs
62284+
description: |-
62285+
Whether filters (Security Filters or Index Query depending on the pricing model) are
62286+
present and correctly configured to route logs into Cloud SIEM.
6227562287
example: true
6227662288
type: boolean
6227762289
integration_installed_status:
6227862290
$ref: "#/components/schemas/SecurityMonitoringContentPackIntegrationStatus"
6227962291
logs_last_collected:
6228062292
$ref: "#/components/schemas/SecurityMonitoringContentPackTimestampBucket"
6228162293
logs_seen_from_any_index:
62282-
description: Whether logs have been seen from any index
62294+
description: Whether logs for this content pack have been seen in any Datadog index within the last 72 hours.
6228362295
example: true
6228462296
type: boolean
6228562297
state:
@@ -62344,7 +62356,7 @@ components:
6234462356
- meta
6234562357
type: object
6234662358
SecurityMonitoringContentPackStatus:
62347-
description: The current status of a content pack
62359+
description: The current operational status of a content pack.
6234862360
enum:
6234962361
- install
6235062362
- activate
@@ -62354,6 +62366,13 @@ components:
6235462366
- broken
6235562367
example: active
6235662368
type: string
62369+
x-enum-descriptions:
62370+
- Not activated; no logs detected in the last 72 hours.
62371+
- Not activated; logs are flowing into a Datadog index but not yet routed through Cloud SIEM.
62372+
- Activated; awaiting first log ingestion.
62373+
- Activated; logs received within the last 24 hours.
62374+
- Activated; integration not installed or logs last seen 24 to 72 hours ago.
62375+
- Activated; no logs for over 72 hours, filter missing, or Cloud SIEM index incorrectly ordered.
6235762376
x-enum-varnames:
6235862377
- INSTALL
6235962378
- ACTIVATE
@@ -62362,7 +62381,7 @@ components:
6236262381
- WARNING
6236362382
- BROKEN
6236462383
SecurityMonitoringContentPackTimestampBucket:
62365-
description: Timestamp bucket indicating when logs were last collected
62384+
description: Timestamp bucket indicating when logs were last collected.
6236662385
enum:
6236762386
- not_seen
6236862387
- within_24_hours
@@ -62371,6 +62390,12 @@ components:
6237162390
- over_30d
6237262391
example: within_24_hours
6237362392
type: string
62393+
x-enum-descriptions:
62394+
- No logs observed.
62395+
- Logs received within the last 24 hours.
62396+
- Logs last seen 24 to 72 hours ago.
62397+
- Logs last seen 3 to 30 days ago.
62398+
- Logs last seen more than 30 days ago.
6237462399
x-enum-varnames:
6237562400
- NOT_SEEN
6237662401
- WITHIN_24_HOURS
@@ -63461,7 +63486,7 @@ components:
6346163486
- $ref: "#/components/schemas/SecurityMonitoringSignalRulePayload"
6346263487
- $ref: "#/components/schemas/CloudConfigurationRulePayload"
6346363488
SecurityMonitoringSKU:
63464-
description: The SIEM pricing model (SKU) for the organization
63489+
description: The Cloud SIEM pricing model (SKU) for the organization.
6346563490
enum:
6346663491
- per_gb_analyzed
6346763492
- per_event_in_siem_index_2023
@@ -117994,9 +118019,8 @@ paths:
117994118019
/api/v2/security_monitoring/content_packs/states:
117995118020
get:
117996118021
description: |-
117997-
Get the activation and configuration states for all security monitoring content packs.
117998-
This endpoint returns status information about each content pack including activation state,
117999-
integration status, and log collection status.
118022+
Get the activation state, integration status, and log collection status
118023+
for all Cloud SIEM content packs.
118000118024
operationId: GetContentPacksStates
118001118025
responses:
118002118026
"200":
@@ -118019,21 +118043,31 @@ paths:
118019118043
description: Not Found
118020118044
"429":
118021118045
$ref: "#/components/responses/TooManyRequestsResponse"
118046+
security:
118047+
- apiKeyAuth: []
118048+
appKeyAuth: []
118049+
- AuthZ:
118050+
- security_monitoring_filters_read
118022118051
summary: Get content pack states
118023118052
tags:
118024118053
- Security Monitoring
118054+
"x-permission":
118055+
operator: OR
118056+
permissions:
118057+
- security_monitoring_filters_read
118058+
- logs_read_index_data
118025118059
x-unstable: |-
118026118060
**Note**: This endpoint is in preview and is subject to change.
118027118061
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
118028118062
/api/v2/security_monitoring/content_packs/{content_pack_id}/activate:
118029118063
put:
118030118064
description: |-
118031-
Activate a security monitoring content pack. This operation configures the necessary
118065+
Activate a Cloud SIEM content pack. This operation configures the necessary
118032118066
log filters or security filters depending on the pricing model and updates the content
118033118067
pack activation state.
118034118068
operationId: ActivateContentPack
118035118069
parameters:
118036-
- description: The ID of the content pack to activate.
118070+
- description: The ID of the content pack to activate (for example, `aws-cloudtrail`).
118037118071
in: path
118038118072
name: content_pack_id
118039118073
required: true
@@ -118057,20 +118091,30 @@ paths:
118057118091
description: Not Found
118058118092
"429":
118059118093
$ref: "#/components/responses/TooManyRequestsResponse"
118094+
security:
118095+
- apiKeyAuth: []
118096+
appKeyAuth: []
118097+
- AuthZ:
118098+
- security_monitoring_filters_write
118060118099
summary: Activate content pack
118061118100
tags:
118062118101
- Security Monitoring
118102+
"x-permission":
118103+
operator: OR
118104+
permissions:
118105+
- security_monitoring_filters_write
118106+
- logs_modify_indexes
118063118107
x-unstable: |-
118064118108
**Note**: This endpoint is in preview and is subject to change.
118065118109
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
118066118110
/api/v2/security_monitoring/content_packs/{content_pack_id}/deactivate:
118067118111
put:
118068118112
description: |-
118069-
Deactivate a security monitoring content pack. This operation removes the content pack's
118113+
Deactivate a Cloud SIEM content pack. This operation removes the content pack's
118070118114
configuration from log filters or security filters and updates the content pack activation state.
118071118115
operationId: DeactivateContentPack
118072118116
parameters:
118073-
- description: The ID of the content pack to deactivate.
118117+
- description: The ID of the content pack to deactivate (for example, `aws-cloudtrail`).
118074118118
in: path
118075118119
name: content_pack_id
118076118120
required: true
@@ -118094,9 +118138,19 @@ paths:
118094118138
description: Not Found
118095118139
"429":
118096118140
$ref: "#/components/responses/TooManyRequestsResponse"
118141+
security:
118142+
- apiKeyAuth: []
118143+
appKeyAuth: []
118144+
- AuthZ:
118145+
- security_monitoring_filters_write
118097118146
summary: Deactivate content pack
118098118147
tags:
118099118148
- Security Monitoring
118149+
"x-permission":
118150+
operator: OR
118151+
permissions:
118152+
- security_monitoring_filters_write
118153+
- logs_modify_indexes
118100118154
x-unstable: |-
118101118155
**Note**: This endpoint is in preview and is subject to change.
118102118156
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).

services/security_monitoring/src/v2/SecurityMonitoringApi.ts

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,7 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
191191
applySecurityAuthentication(_config, requestContext, [
192192
"apiKeyAuth",
193193
"appKeyAuth",
194+
"AuthZ",
194195
]);
195196

196197
return requestContext;
@@ -1386,6 +1387,7 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
13861387
applySecurityAuthentication(_config, requestContext, [
13871388
"apiKeyAuth",
13881389
"appKeyAuth",
1390+
"AuthZ",
13891391
]);
13901392

13911393
return requestContext;
@@ -2139,6 +2141,7 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
21392141
applySecurityAuthentication(_config, requestContext, [
21402142
"apiKeyAuth",
21412143
"appKeyAuth",
2144+
"AuthZ",
21422145
]);
21432146

21442147
return requestContext;
@@ -11819,7 +11822,7 @@ export class SecurityMonitoringApiResponseProcessor {
1181911822

1182011823
export interface SecurityMonitoringApiActivateContentPackRequest {
1182111824
/**
11822-
* The ID of the content pack to activate.
11825+
* The ID of the content pack to activate (for example, `aws-cloudtrail`).
1182311826
* @type string
1182411827
*/
1182511828
contentPackId: string;
@@ -11995,7 +11998,7 @@ export interface SecurityMonitoringApiCreateVulnerabilityNotificationRuleRequest
1199511998

1199611999
export interface SecurityMonitoringApiDeactivateContentPackRequest {
1199712000
/**
11998-
* The ID of the content pack to deactivate.
12001+
* The ID of the content pack to deactivate (for example, `aws-cloudtrail`).
1199912002
* @type string
1200012003
*/
1200112004
contentPackId: string;
@@ -13240,7 +13243,7 @@ export class SecurityMonitoringApi {
1324013243
}
1324113244

1324213245
/**
13243-
* Activate a security monitoring content pack. This operation configures the necessary
13246+
* Activate a Cloud SIEM content pack. This operation configures the necessary
1324413247
* log filters or security filters depending on the pricing model and updates the content
1324513248
* pack activation state.
1324613249
* @param param The request object
@@ -13746,7 +13749,7 @@ export class SecurityMonitoringApi {
1374613749
}
1374713750

1374813751
/**
13749-
* Deactivate a security monitoring content pack. This operation removes the content pack's
13752+
* Deactivate a Cloud SIEM content pack. This operation removes the content pack's
1375013753
* configuration from log filters or security filters and updates the content pack activation state.
1375113754
* @param param The request object
1375213755
*/
@@ -14070,9 +14073,8 @@ export class SecurityMonitoringApi {
1407014073
}
1407114074

1407214075
/**
14073-
* Get the activation and configuration states for all security monitoring content packs.
14074-
* This endpoint returns status information about each content pack including activation state,
14075-
* integration status, and log collection status.
14076+
* Get the activation state, integration status, and log collection status
14077+
* for all Cloud SIEM content packs.
1407614078
* @param param The request object
1407714079
*/
1407814080
public getContentPacksStates(

services/security_monitoring/src/v2/models/SecurityMonitoringContentPackActivation.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { UnparsedObject } from "@datadog/datadog-api-client";
22

33
/**
4-
* The activation status of a content pack
4+
* The activation status of a content pack.
55
*/
66
export type SecurityMonitoringContentPackActivation =
77
| typeof NEVER_ACTIVATED

services/security_monitoring/src/v2/models/SecurityMonitoringContentPackIntegrationStatus.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { UnparsedObject } from "@datadog/datadog-api-client";
22

33
/**
4-
* The installation status of the related integration
4+
* The installation status of the related integration.
55
*/
66
export type SecurityMonitoringContentPackIntegrationStatus =
77
| typeof INSTALLED

services/security_monitoring/src/v2/models/SecurityMonitoringContentPackStateAttributes.ts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,28 @@ export class SecurityMonitoringContentPackStateAttributes {
1414
*/
1515
"cloudSiemIndexIncorrect": boolean;
1616
/**
17-
* The activation status of a content pack
17+
* The activation status of a content pack.
1818
*/
1919
"cpActivation": SecurityMonitoringContentPackActivation;
2020
/**
21-
* Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs
21+
* Whether filters (Security Filters or Index Query depending on the pricing model) are
22+
* present and correctly configured to route logs into Cloud SIEM.
2223
*/
2324
"filtersConfiguredForLogs": boolean;
2425
/**
25-
* The installation status of the related integration
26+
* The installation status of the related integration.
2627
*/
2728
"integrationInstalledStatus"?: SecurityMonitoringContentPackIntegrationStatus;
2829
/**
29-
* Timestamp bucket indicating when logs were last collected
30+
* Timestamp bucket indicating when logs were last collected.
3031
*/
3132
"logsLastCollected": SecurityMonitoringContentPackTimestampBucket;
3233
/**
33-
* Whether logs have been seen from any index
34+
* Whether logs for this content pack have been seen in any Datadog index within the last 72 hours.
3435
*/
3536
"logsSeenFromAnyIndex": boolean;
3637
/**
37-
* The current status of a content pack
38+
* The current operational status of a content pack.
3839
*/
3940
"state": SecurityMonitoringContentPackStatus;
4041
/**

services/security_monitoring/src/v2/models/SecurityMonitoringContentPackStateMeta.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export class SecurityMonitoringContentPackStateMeta {
1111
*/
1212
"cloudSiemIndexIncorrect": boolean;
1313
/**
14-
* The SIEM pricing model (SKU) for the organization
14+
* The Cloud SIEM pricing model (SKU) for the organization.
1515
*/
1616
"sku": SecurityMonitoringSKU;
1717
/**

services/security_monitoring/src/v2/models/SecurityMonitoringContentPackStatus.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { UnparsedObject } from "@datadog/datadog-api-client";
22

33
/**
4-
* The current status of a content pack
4+
* The current operational status of a content pack.
55
*/
66
export type SecurityMonitoringContentPackStatus =
77
| typeof INSTALL

services/security_monitoring/src/v2/models/SecurityMonitoringContentPackTimestampBucket.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { UnparsedObject } from "@datadog/datadog-api-client";
22

33
/**
4-
* Timestamp bucket indicating when logs were last collected
4+
* Timestamp bucket indicating when logs were last collected.
55
*/
66
export type SecurityMonitoringContentPackTimestampBucket =
77
| typeof NOT_SEEN

services/security_monitoring/src/v2/models/SecurityMonitoringSKU.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { UnparsedObject } from "@datadog/datadog-api-client";
22

33
/**
4-
* The SIEM pricing model (SKU) for the organization
4+
* The Cloud SIEM pricing model (SKU) for the organization.
55
*/
66
export type SecurityMonitoringSKU =
77
| typeof PER_GB_ANALYZED

0 commit comments

Comments
 (0)