Skip to content

Commit 4594006

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 16954f9 of spec repo
1 parent 7671ca8 commit 4594006

9 files changed

+88
-34
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 67 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -61254,19 +61254,23 @@ components:
6125461254
- DONE
6125561255
- TIMEOUT
6125661256
SecurityMonitoringContentPackActivation:
61257-
description: The activation status of a content pack
61257+
description: The activation status of a content pack.
6125861258
enum:
6125961259
- never_activated
6126061260
- activated
6126161261
- deactivated
6126261262
example: activated
6126361263
type: string
61264+
x-enum-descriptions:
61265+
- Pack has never been activated for this organization.
61266+
- Pack is currently activated.
61267+
- Pack was previously activated but has since been deactivated.
6126461268
x-enum-varnames:
6126561269
- NEVER_ACTIVATED
6126661270
- ACTIVATED
6126761271
- DEACTIVATED
6126861272
SecurityMonitoringContentPackIntegrationStatus:
61269-
description: The installation status of the related integration
61273+
description: The installation status of the related integration.
6127061274
enum:
6127161275
- installed
6127261276
- available
@@ -61275,6 +61279,12 @@ components:
6127561279
- error
6127661280
example: installed
6127761281
type: string
61282+
x-enum-descriptions:
61283+
- Integration is fully installed.
61284+
- Integration exists in the catalog but is not installed.
61285+
- Integration is only partially configured.
61286+
- Integration detected (for example, logs are flowing) but not explicitly installed.
61287+
- Integration is in an error state.
6127861288
x-enum-varnames:
6127961289
- INSTALLED
6128061290
- AVAILABLE
@@ -61291,15 +61301,17 @@ components:
6129161301
cp_activation:
6129261302
$ref: "#/components/schemas/SecurityMonitoringContentPackActivation"
6129361303
filters_configured_for_logs:
61294-
description: Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs
61304+
description: |-
61305+
Whether filters (Security Filters or Index Query depending on the pricing model) are
61306+
present and correctly configured to route logs into Cloud SIEM.
6129561307
example: true
6129661308
type: boolean
6129761309
integration_installed_status:
6129861310
$ref: "#/components/schemas/SecurityMonitoringContentPackIntegrationStatus"
6129961311
logs_last_collected:
6130061312
$ref: "#/components/schemas/SecurityMonitoringContentPackTimestampBucket"
6130161313
logs_seen_from_any_index:
61302-
description: Whether logs have been seen from any index
61314+
description: Whether logs for this content pack have been seen in any Datadog index within the last 72 hours.
6130361315
example: true
6130461316
type: boolean
6130561317
state:
@@ -61364,7 +61376,7 @@ components:
6136461376
- meta
6136561377
type: object
6136661378
SecurityMonitoringContentPackStatus:
61367-
description: The current status of a content pack
61379+
description: The current operational status of a content pack.
6136861380
enum:
6136961381
- install
6137061382
- activate
@@ -61374,6 +61386,13 @@ components:
6137461386
- broken
6137561387
example: active
6137661388
type: string
61389+
x-enum-descriptions:
61390+
- Not activated; no logs detected in the last 72 hours.
61391+
- Not activated; logs are flowing into a Datadog index but not yet routed through Cloud SIEM.
61392+
- Activated; awaiting first log ingestion.
61393+
- Activated; logs received within the last 24 hours.
61394+
- Activated; integration not installed or logs last seen 24 to 72 hours ago.
61395+
- Activated; no logs for over 72 hours, filter missing, or Cloud SIEM index incorrectly ordered.
6137761396
x-enum-varnames:
6137861397
- INSTALL
6137961398
- ACTIVATE
@@ -61382,7 +61401,7 @@ components:
6138261401
- WARNING
6138361402
- BROKEN
6138461403
SecurityMonitoringContentPackTimestampBucket:
61385-
description: Timestamp bucket indicating when logs were last collected
61404+
description: Timestamp bucket indicating when logs were last collected.
6138661405
enum:
6138761406
- not_seen
6138861407
- within_24_hours
@@ -61391,6 +61410,12 @@ components:
6139161410
- over_30d
6139261411
example: within_24_hours
6139361412
type: string
61413+
x-enum-descriptions:
61414+
- No logs observed.
61415+
- Logs received within the last 24 hours.
61416+
- Logs last seen 24 to 72 hours ago.
61417+
- Logs last seen 3 to 30 days ago.
61418+
- Logs last seen more than 30 days ago.
6139461419
x-enum-varnames:
6139561420
- NOT_SEEN
6139661421
- WITHIN_24_HOURS
@@ -62481,7 +62506,7 @@ components:
6248162506
- $ref: "#/components/schemas/SecurityMonitoringSignalRulePayload"
6248262507
- $ref: "#/components/schemas/CloudConfigurationRulePayload"
6248362508
SecurityMonitoringSKU:
62484-
description: The SIEM pricing model (SKU) for the organization
62509+
description: The Cloud SIEM pricing model (SKU) for the organization.
6248562510
enum:
6248662511
- per_gb_analyzed
6248762512
- per_event_in_siem_index_2023
@@ -112316,10 +112341,7 @@ paths:
112316112341
- Security Monitoring
112317112342
/api/v2/security_monitoring/content_packs/states:
112318112343
get:
112319-
description: |-
112320-
Get the activation and configuration states for all security monitoring content packs.
112321-
This endpoint returns status information about each content pack including activation state,
112322-
integration status, and log collection status.
112344+
description: Get the activation state, integration status, and log collection status for all Cloud SIEM content packs.
112323112345
operationId: GetContentPacksStates
112324112346
responses:
112325112347
"200":
@@ -112342,21 +112364,31 @@ paths:
112342112364
description: Not Found
112343112365
"429":
112344112366
$ref: "#/components/responses/TooManyRequestsResponse"
112367+
security:
112368+
- apiKeyAuth: []
112369+
appKeyAuth: []
112370+
- AuthZ:
112371+
- security_monitoring_filters_read
112345112372
summary: Get content pack states
112346112373
tags:
112347112374
- Security Monitoring
112375+
"x-permission":
112376+
operator: OR
112377+
permissions:
112378+
- security_monitoring_filters_read
112379+
- logs_read_index_data
112348112380
x-unstable: |-
112349112381
**Note**: This endpoint is in preview and is subject to change.
112350112382
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
112351112383
/api/v2/security_monitoring/content_packs/{content_pack_id}/activate:
112352112384
put:
112353112385
description: |-
112354-
Activate a security monitoring content pack. This operation configures the necessary
112386+
Activate a Cloud SIEM content pack. This operation configures the necessary
112355112387
log filters or security filters depending on the pricing model and updates the content
112356112388
pack activation state.
112357112389
operationId: ActivateContentPack
112358112390
parameters:
112359-
- description: The ID of the content pack to activate.
112391+
- description: The ID of the content pack to activate (for example, `aws-cloudtrail`).
112360112392
in: path
112361112393
name: content_pack_id
112362112394
required: true
@@ -112380,20 +112412,30 @@ paths:
112380112412
description: Not Found
112381112413
"429":
112382112414
$ref: "#/components/responses/TooManyRequestsResponse"
112415+
security:
112416+
- apiKeyAuth: []
112417+
appKeyAuth: []
112418+
- AuthZ:
112419+
- security_monitoring_filters_write
112383112420
summary: Activate content pack
112384112421
tags:
112385112422
- Security Monitoring
112423+
"x-permission":
112424+
operator: OR
112425+
permissions:
112426+
- security_monitoring_filters_write
112427+
- logs_modify_indexes
112386112428
x-unstable: |-
112387112429
**Note**: This endpoint is in preview and is subject to change.
112388112430
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
112389112431
/api/v2/security_monitoring/content_packs/{content_pack_id}/deactivate:
112390112432
put:
112391112433
description: |-
112392-
Deactivate a security monitoring content pack. This operation removes the content pack's
112434+
Deactivate a Cloud SIEM content pack. This operation removes the content pack's
112393112435
configuration from log filters or security filters and updates the content pack activation state.
112394112436
operationId: DeactivateContentPack
112395112437
parameters:
112396-
- description: The ID of the content pack to deactivate.
112438+
- description: The ID of the content pack to deactivate (for example, `aws-cloudtrail`).
112397112439
in: path
112398112440
name: content_pack_id
112399112441
required: true
@@ -112417,9 +112459,19 @@ paths:
112417112459
description: Not Found
112418112460
"429":
112419112461
$ref: "#/components/responses/TooManyRequestsResponse"
112462+
security:
112463+
- apiKeyAuth: []
112464+
appKeyAuth: []
112465+
- AuthZ:
112466+
- security_monitoring_filters_write
112420112467
summary: Deactivate content pack
112421112468
tags:
112422112469
- Security Monitoring
112470+
"x-permission":
112471+
operator: OR
112472+
permissions:
112473+
- security_monitoring_filters_write
112474+
- logs_modify_indexes
112423112475
x-unstable: |-
112424112476
**Note**: This endpoint is in preview and is subject to change.
112425112477
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).

packages/datadog-api-client-v2/apis/SecurityMonitoringApi.ts

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
154154
applySecurityAuthentication(_config, requestContext, [
155155
"apiKeyAuth",
156156
"appKeyAuth",
157+
"AuthZ",
157158
]);
158159

159160
return requestContext;
@@ -1006,6 +1007,7 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
10061007
applySecurityAuthentication(_config, requestContext, [
10071008
"apiKeyAuth",
10081009
"appKeyAuth",
1010+
"AuthZ",
10091011
]);
10101012

10111013
return requestContext;
@@ -1551,6 +1553,7 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
15511553
applySecurityAuthentication(_config, requestContext, [
15521554
"apiKeyAuth",
15531555
"appKeyAuth",
1556+
"AuthZ",
15541557
]);
15551558

15561559
return requestContext;
@@ -10522,7 +10525,7 @@ export class SecurityMonitoringApiResponseProcessor {
1052210525

1052310526
export interface SecurityMonitoringApiActivateContentPackRequest {
1052410527
/**
10525-
* The ID of the content pack to activate.
10528+
* The ID of the content pack to activate (for example, `aws-cloudtrail`).
1052610529
* @type string
1052710530
*/
1052810531
contentPackId: string;
@@ -10672,7 +10675,7 @@ export interface SecurityMonitoringApiCreateVulnerabilityNotificationRuleRequest
1067210675

1067310676
export interface SecurityMonitoringApiDeactivateContentPackRequest {
1067410677
/**
10675-
* The ID of the content pack to deactivate.
10678+
* The ID of the content pack to deactivate (for example, `aws-cloudtrail`).
1067610679
* @type string
1067710680
*/
1067810681
contentPackId: string;
@@ -11865,7 +11868,7 @@ export class SecurityMonitoringApi {
1186511868
}
1186611869

1186711870
/**
11868-
* Activate a security monitoring content pack. This operation configures the necessary
11871+
* Activate a Cloud SIEM content pack. This operation configures the necessary
1186911872
* log filters or security filters depending on the pricing model and updates the content
1187011873
* pack activation state.
1187111874
* @param param The request object
@@ -12316,7 +12319,7 @@ export class SecurityMonitoringApi {
1231612319
}
1231712320

1231812321
/**
12319-
* Deactivate a security monitoring content pack. This operation removes the content pack's
12322+
* Deactivate a Cloud SIEM content pack. This operation removes the content pack's
1232012323
* configuration from log filters or security filters and updates the content pack activation state.
1232112324
* @param param The request object
1232212325
*/
@@ -12613,9 +12616,7 @@ export class SecurityMonitoringApi {
1261312616
}
1261412617

1261512618
/**
12616-
* Get the activation and configuration states for all security monitoring content packs.
12617-
* This endpoint returns status information about each content pack including activation state,
12618-
* integration status, and log collection status.
12619+
* Get the activation state, integration status, and log collection status for all Cloud SIEM content packs.
1261912620
* @param param The request object
1262012621
*/
1262112622
public getContentPacksStates(

packages/datadog-api-client-v2/models/SecurityMonitoringContentPackActivation.ts

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

99
/**
10-
* The activation status of a content pack
10+
* The activation status of a content pack.
1111
*/
1212

1313
export type SecurityMonitoringContentPackActivation =

packages/datadog-api-client-v2/models/SecurityMonitoringContentPackIntegrationStatus.ts

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

99
/**
10-
* The installation status of the related integration
10+
* The installation status of the related integration.
1111
*/
1212

1313
export type SecurityMonitoringContentPackIntegrationStatus =

packages/datadog-api-client-v2/models/SecurityMonitoringContentPackStateAttributes.ts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,27 +19,28 @@ export class SecurityMonitoringContentPackStateAttributes {
1919
*/
2020
"cloudSiemIndexIncorrect": boolean;
2121
/**
22-
* The activation status of a content pack
22+
* The activation status of a content pack.
2323
*/
2424
"cpActivation": SecurityMonitoringContentPackActivation;
2525
/**
26-
* Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs
26+
* Whether filters (Security Filters or Index Query depending on the pricing model) are
27+
* present and correctly configured to route logs into Cloud SIEM.
2728
*/
2829
"filtersConfiguredForLogs": boolean;
2930
/**
30-
* The installation status of the related integration
31+
* The installation status of the related integration.
3132
*/
3233
"integrationInstalledStatus"?: SecurityMonitoringContentPackIntegrationStatus;
3334
/**
34-
* Timestamp bucket indicating when logs were last collected
35+
* Timestamp bucket indicating when logs were last collected.
3536
*/
3637
"logsLastCollected": SecurityMonitoringContentPackTimestampBucket;
3738
/**
38-
* Whether logs have been seen from any index
39+
* Whether logs for this content pack have been seen in any Datadog index within the last 72 hours.
3940
*/
4041
"logsSeenFromAnyIndex": boolean;
4142
/**
42-
* The current status of a content pack
43+
* The current operational status of a content pack.
4344
*/
4445
"state": SecurityMonitoringContentPackStatus;
4546

packages/datadog-api-client-v2/models/SecurityMonitoringContentPackStateMeta.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export class SecurityMonitoringContentPackStateMeta {
1616
*/
1717
"cloudSiemIndexIncorrect": boolean;
1818
/**
19-
* The SIEM pricing model (SKU) for the organization
19+
* The Cloud SIEM pricing model (SKU) for the organization.
2020
*/
2121
"sku": SecurityMonitoringSKU;
2222

packages/datadog-api-client-v2/models/SecurityMonitoringContentPackStatus.ts

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

99
/**
10-
* The current status of a content pack
10+
* The current operational status of a content pack.
1111
*/
1212

1313
export type SecurityMonitoringContentPackStatus =

packages/datadog-api-client-v2/models/SecurityMonitoringContentPackTimestampBucket.ts

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

99
/**
10-
* Timestamp bucket indicating when logs were last collected
10+
* Timestamp bucket indicating when logs were last collected.
1111
*/
1212

1313
export type SecurityMonitoringContentPackTimestampBucket =

packages/datadog-api-client-v2/models/SecurityMonitoringSKU.ts

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

99
/**
10-
* The SIEM pricing model (SKU) for the organization
10+
* The Cloud SIEM pricing model (SKU) for the organization.
1111
*/
1212

1313
export type SecurityMonitoringSKU =

0 commit comments

Comments
 (0)