Skip to content

Commit 50e1990

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 6849118 of spec repo
1 parent 326bc96 commit 50e1990

9 files changed

Lines changed: 98 additions & 59 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 70 additions & 30 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":
@@ -112329,11 +112351,7 @@ paths:
112329112351
$ref: "#/components/schemas/SecurityMonitoringContentPackStatesResponse"
112330112352
description: OK
112331112353
"403":
112332-
content:
112333-
application/json:
112334-
schema:
112335-
$ref: "#/components/schemas/JSONAPIErrorResponse"
112336-
description: Forbidden
112354+
$ref: "#/components/responses/NotAuthorizedResponse"
112337112355
"404":
112338112356
content:
112339112357
application/json:
@@ -112342,21 +112360,31 @@ paths:
112342112360
description: Not Found
112343112361
"429":
112344112362
$ref: "#/components/responses/TooManyRequestsResponse"
112363+
security:
112364+
- apiKeyAuth: []
112365+
appKeyAuth: []
112366+
- AuthZ:
112367+
- security_monitoring_filters_read
112345112368
summary: Get content pack states
112346112369
tags:
112347112370
- Security Monitoring
112371+
"x-permission":
112372+
operator: OR
112373+
permissions:
112374+
- security_monitoring_filters_read
112375+
- logs_read_index_data
112348112376
x-unstable: |-
112349112377
**Note**: This endpoint is in preview and is subject to change.
112350112378
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
112351112379
/api/v2/security_monitoring/content_packs/{content_pack_id}/activate:
112352112380
put:
112353112381
description: |-
112354-
Activate a security monitoring content pack. This operation configures the necessary
112382+
Activate a Cloud SIEM content pack. This operation configures the necessary
112355112383
log filters or security filters depending on the pricing model and updates the content
112356112384
pack activation state.
112357112385
operationId: ActivateContentPack
112358112386
parameters:
112359-
- description: The ID of the content pack to activate.
112387+
- description: The ID of the content pack to activate (for example, `aws-cloudtrail`).
112360112388
in: path
112361112389
name: content_pack_id
112362112390
required: true
@@ -112367,11 +112395,7 @@ paths:
112367112395
"202":
112368112396
description: Accepted
112369112397
"403":
112370-
content:
112371-
application/json:
112372-
schema:
112373-
$ref: "#/components/schemas/JSONAPIErrorResponse"
112374-
description: Forbidden
112398+
$ref: "#/components/responses/NotAuthorizedResponse"
112375112399
"404":
112376112400
content:
112377112401
application/json:
@@ -112380,20 +112404,30 @@ paths:
112380112404
description: Not Found
112381112405
"429":
112382112406
$ref: "#/components/responses/TooManyRequestsResponse"
112407+
security:
112408+
- apiKeyAuth: []
112409+
appKeyAuth: []
112410+
- AuthZ:
112411+
- security_monitoring_filters_write
112383112412
summary: Activate content pack
112384112413
tags:
112385112414
- Security Monitoring
112415+
"x-permission":
112416+
operator: OR
112417+
permissions:
112418+
- security_monitoring_filters_write
112419+
- logs_modify_indexes
112386112420
x-unstable: |-
112387112421
**Note**: This endpoint is in preview and is subject to change.
112388112422
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
112389112423
/api/v2/security_monitoring/content_packs/{content_pack_id}/deactivate:
112390112424
put:
112391112425
description: |-
112392-
Deactivate a security monitoring content pack. This operation removes the content pack's
112426+
Deactivate a Cloud SIEM content pack. This operation removes the content pack's
112393112427
configuration from log filters or security filters and updates the content pack activation state.
112394112428
operationId: DeactivateContentPack
112395112429
parameters:
112396-
- description: The ID of the content pack to deactivate.
112430+
- description: The ID of the content pack to deactivate (for example, `aws-cloudtrail`).
112397112431
in: path
112398112432
name: content_pack_id
112399112433
required: true
@@ -112404,11 +112438,7 @@ paths:
112404112438
"202":
112405112439
description: Accepted
112406112440
"403":
112407-
content:
112408-
application/json:
112409-
schema:
112410-
$ref: "#/components/schemas/JSONAPIErrorResponse"
112411-
description: Forbidden
112441+
$ref: "#/components/responses/NotAuthorizedResponse"
112412112442
"404":
112413112443
content:
112414112444
application/json:
@@ -112417,9 +112447,19 @@ paths:
112417112447
description: Not Found
112418112448
"429":
112419112449
$ref: "#/components/responses/TooManyRequestsResponse"
112450+
security:
112451+
- apiKeyAuth: []
112452+
appKeyAuth: []
112453+
- AuthZ:
112454+
- security_monitoring_filters_write
112420112455
summary: Deactivate content pack
112421112456
tags:
112422112457
- Security Monitoring
112458+
"x-permission":
112459+
operator: OR
112460+
permissions:
112461+
- security_monitoring_filters_write
112462+
- logs_modify_indexes
112423112463
x-unstable: |-
112424112464
**Note**: This endpoint is in preview and is subject to change.
112425112465
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).

api/datadogV2/api_security_monitoring.go

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import (
2121
type SecurityMonitoringApi datadog.Service
2222

2323
// ActivateContentPack Activate content pack.
24-
// Activate a security monitoring content pack. This operation configures the necessary
24+
// Activate a Cloud SIEM content pack. This operation configures the necessary
2525
// log filters or security filters depending on the pricing model and updates the content
2626
// pack activation state.
2727
func (a *SecurityMonitoringApi) ActivateContentPack(ctx _context.Context, contentPackId string) (*_nethttp.Response, error) {
@@ -85,17 +85,17 @@ func (a *SecurityMonitoringApi) ActivateContentPack(ctx _context.Context, conten
8585
ErrorBody: localVarBody,
8686
ErrorMessage: localVarHTTPResponse.Status,
8787
}
88-
if localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 404 {
89-
var v JSONAPIErrorResponse
88+
if localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 429 {
89+
var v APIErrorResponse
9090
err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
9191
if err != nil {
9292
return localVarHTTPResponse, newErr
9393
}
9494
newErr.ErrorModel = v
9595
return localVarHTTPResponse, newErr
9696
}
97-
if localVarHTTPResponse.StatusCode == 429 {
98-
var v APIErrorResponse
97+
if localVarHTTPResponse.StatusCode == 404 {
98+
var v JSONAPIErrorResponse
9999
err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
100100
if err != nil {
101101
return localVarHTTPResponse, newErr
@@ -1577,7 +1577,7 @@ func (a *SecurityMonitoringApi) CreateVulnerabilityNotificationRule(ctx _context
15771577
}
15781578

15791579
// DeactivateContentPack Deactivate content pack.
1580-
// Deactivate a security monitoring content pack. This operation removes the content pack's
1580+
// Deactivate a Cloud SIEM content pack. This operation removes the content pack's
15811581
// configuration from log filters or security filters and updates the content pack activation state.
15821582
func (a *SecurityMonitoringApi) DeactivateContentPack(ctx _context.Context, contentPackId string) (*_nethttp.Response, error) {
15831583
var (
@@ -1640,17 +1640,17 @@ func (a *SecurityMonitoringApi) DeactivateContentPack(ctx _context.Context, cont
16401640
ErrorBody: localVarBody,
16411641
ErrorMessage: localVarHTTPResponse.Status,
16421642
}
1643-
if localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 404 {
1644-
var v JSONAPIErrorResponse
1643+
if localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 429 {
1644+
var v APIErrorResponse
16451645
err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
16461646
if err != nil {
16471647
return localVarHTTPResponse, newErr
16481648
}
16491649
newErr.ErrorModel = v
16501650
return localVarHTTPResponse, newErr
16511651
}
1652-
if localVarHTTPResponse.StatusCode == 429 {
1653-
var v APIErrorResponse
1652+
if localVarHTTPResponse.StatusCode == 404 {
1653+
var v JSONAPIErrorResponse
16541654
err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
16551655
if err != nil {
16561656
return localVarHTTPResponse, newErr
@@ -2542,9 +2542,7 @@ func (a *SecurityMonitoringApi) EditSecurityMonitoringSignalState(ctx _context.C
25422542
}
25432543

25442544
// GetContentPacksStates Get content pack states.
2545-
// Get the activation and configuration states for all security monitoring content packs.
2546-
// This endpoint returns status information about each content pack including activation state,
2547-
// integration status, and log collection status.
2545+
// Get the activation state, integration status, and log collection status for all Cloud SIEM content packs.
25482546
func (a *SecurityMonitoringApi) GetContentPacksStates(ctx _context.Context) (SecurityMonitoringContentPackStatesResponse, *_nethttp.Response, error) {
25492547
var (
25502548
localVarHTTPMethod = _nethttp.MethodGet
@@ -2606,17 +2604,17 @@ func (a *SecurityMonitoringApi) GetContentPacksStates(ctx _context.Context) (Sec
26062604
ErrorBody: localVarBody,
26072605
ErrorMessage: localVarHTTPResponse.Status,
26082606
}
2609-
if localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 404 {
2610-
var v JSONAPIErrorResponse
2607+
if localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 429 {
2608+
var v APIErrorResponse
26112609
err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
26122610
if err != nil {
26132611
return localVarReturnValue, localVarHTTPResponse, newErr
26142612
}
26152613
newErr.ErrorModel = v
26162614
return localVarReturnValue, localVarHTTPResponse, newErr
26172615
}
2618-
if localVarHTTPResponse.StatusCode == 429 {
2619-
var v APIErrorResponse
2616+
if localVarHTTPResponse.StatusCode == 404 {
2617+
var v JSONAPIErrorResponse
26202618
err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
26212619
if err != nil {
26222620
return localVarReturnValue, localVarHTTPResponse, newErr

api/datadogV2/model_security_monitoring_content_pack_activation.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
1111
)
1212

13-
// SecurityMonitoringContentPackActivation The activation status of a content pack
13+
// SecurityMonitoringContentPackActivation The activation status of a content pack.
1414
type SecurityMonitoringContentPackActivation string
1515

1616
// List of SecurityMonitoringContentPackActivation.

api/datadogV2/model_security_monitoring_content_pack_integration_status.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
1111
)
1212

13-
// SecurityMonitoringContentPackIntegrationStatus The installation status of the related integration
13+
// SecurityMonitoringContentPackIntegrationStatus The installation status of the related integration.
1414
type SecurityMonitoringContentPackIntegrationStatus string
1515

1616
// List of SecurityMonitoringContentPackIntegrationStatus.

api/datadogV2/model_security_monitoring_content_pack_state_attributes.go

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,18 @@ import (
1414
type SecurityMonitoringContentPackStateAttributes struct {
1515
// Whether the cloud SIEM index configuration is incorrect (only applies to certain pricing models)
1616
CloudSiemIndexIncorrect bool `json:"cloud_siem_index_incorrect"`
17-
// The activation status of a content pack
17+
// The activation status of a content pack.
1818
CpActivation SecurityMonitoringContentPackActivation `json:"cp_activation"`
19-
// Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs
19+
// Whether filters (Security Filters or Index Query depending on the pricing model) are
20+
// present and correctly configured to route logs into Cloud SIEM.
2021
FiltersConfiguredForLogs bool `json:"filters_configured_for_logs"`
21-
// The installation status of the related integration
22+
// The installation status of the related integration.
2223
IntegrationInstalledStatus *SecurityMonitoringContentPackIntegrationStatus `json:"integration_installed_status,omitempty"`
23-
// Timestamp bucket indicating when logs were last collected
24+
// Timestamp bucket indicating when logs were last collected.
2425
LogsLastCollected SecurityMonitoringContentPackTimestampBucket `json:"logs_last_collected"`
25-
// Whether logs have been seen from any index
26+
// Whether logs for this content pack have been seen in any Datadog index within the last 72 hours.
2627
LogsSeenFromAnyIndex bool `json:"logs_seen_from_any_index"`
27-
// The current status of a content pack
28+
// The current operational status of a content pack.
2829
State SecurityMonitoringContentPackStatus `json:"state"`
2930
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
3031
UnparsedObject map[string]interface{} `json:"-"`

api/datadogV2/model_security_monitoring_content_pack_state_meta.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414
type SecurityMonitoringContentPackStateMeta struct {
1515
// Whether the cloud SIEM index configuration is incorrect at the organization level
1616
CloudSiemIndexIncorrect bool `json:"cloud_siem_index_incorrect"`
17-
// The SIEM pricing model (SKU) for the organization
17+
// The Cloud SIEM pricing model (SKU) for the organization.
1818
Sku SecurityMonitoringSKU `json:"sku"`
1919
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
2020
UnparsedObject map[string]interface{} `json:"-"`

0 commit comments

Comments
 (0)