Skip to content

Commit 744fb71

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 16954f9 of spec repo
1 parent 6ba7e3d commit 744fb71

9 files changed

+88
-37
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/).

lib/datadog_api_client/v2/api/security_monitoring_api.rb

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ def activate_content_pack(content_pack_id, opts = {})
3333

3434
# Activate content pack.
3535
#
36-
# Activate a security monitoring content pack. This operation configures the necessary
36+
# Activate a Cloud SIEM content pack. This operation configures the necessary
3737
# log filters or security filters depending on the pricing model and updates the content
3838
# pack activation state.
3939
#
40-
# @param content_pack_id [String] The ID of the content pack to activate.
40+
# @param content_pack_id [String] The ID of the content pack to activate (for example, `aws-cloudtrail`).
4141
# @param opts [Hash] the optional parameters
4242
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
4343
def activate_content_pack_with_http_info(content_pack_id, opts = {})
@@ -76,7 +76,7 @@ def activate_content_pack_with_http_info(content_pack_id, opts = {})
7676
return_type = opts[:debug_return_type]
7777

7878
# auth_names
79-
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
79+
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
8080

8181
new_options = opts.merge(
8282
:operation => :activate_content_pack,
@@ -1348,10 +1348,10 @@ def deactivate_content_pack(content_pack_id, opts = {})
13481348

13491349
# Deactivate content pack.
13501350
#
1351-
# Deactivate a security monitoring content pack. This operation removes the content pack's
1351+
# Deactivate a Cloud SIEM content pack. This operation removes the content pack's
13521352
# configuration from log filters or security filters and updates the content pack activation state.
13531353
#
1354-
# @param content_pack_id [String] The ID of the content pack to deactivate.
1354+
# @param content_pack_id [String] The ID of the content pack to deactivate (for example, `aws-cloudtrail`).
13551355
# @param opts [Hash] the optional parameters
13561356
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
13571357
def deactivate_content_pack_with_http_info(content_pack_id, opts = {})
@@ -1390,7 +1390,7 @@ def deactivate_content_pack_with_http_info(content_pack_id, opts = {})
13901390
return_type = opts[:debug_return_type]
13911391

13921392
# auth_names
1393-
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
1393+
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
13941394

13951395
new_options = opts.merge(
13961396
:operation => :deactivate_content_pack,
@@ -2235,9 +2235,7 @@ def get_content_packs_states(opts = {})
22352235

22362236
# Get content pack states.
22372237
#
2238-
# Get the activation and configuration states for all security monitoring content packs.
2239-
# This endpoint returns status information about each content pack including activation state,
2240-
# integration status, and log collection status.
2238+
# Get the activation state, integration status, and log collection status for all Cloud SIEM content packs.
22412239
#
22422240
# @param opts [Hash] the optional parameters
22432241
# @return [Array<(SecurityMonitoringContentPackStatesResponse, Integer, Hash)>] SecurityMonitoringContentPackStatesResponse data, response status code and response headers
@@ -2273,7 +2271,7 @@ def get_content_packs_states_with_http_info(opts = {})
22732271
return_type = opts[:debug_return_type] || 'SecurityMonitoringContentPackStatesResponse'
22742272

22752273
# auth_names
2276-
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
2274+
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
22772275

22782276
new_options = opts.merge(
22792277
:operation => :get_content_packs_states,

lib/datadog_api_client/v2/models/security_monitoring_content_pack_activation.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The activation status of a content pack
20+
# The activation status of a content pack.
2121
class SecurityMonitoringContentPackActivation
2222
include BaseEnumModel
2323

lib/datadog_api_client/v2/models/security_monitoring_content_pack_integration_status.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The installation status of the related integration
20+
# The installation status of the related integration.
2121
class SecurityMonitoringContentPackIntegrationStatus
2222
include BaseEnumModel
2323

lib/datadog_api_client/v2/models/security_monitoring_content_pack_state_attributes.rb

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,23 @@ class SecurityMonitoringContentPackStateAttributes
2424
# Whether the cloud SIEM index configuration is incorrect (only applies to certain pricing models)
2525
attr_reader :cloud_siem_index_incorrect
2626

27-
# The activation status of a content pack
27+
# The activation status of a content pack.
2828
attr_reader :cp_activation
2929

30-
# Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs
30+
# Whether filters (Security Filters or Index Query depending on the pricing model) are
31+
# present and correctly configured to route logs into Cloud SIEM.
3132
attr_reader :filters_configured_for_logs
3233

33-
# The installation status of the related integration
34+
# The installation status of the related integration.
3435
attr_accessor :integration_installed_status
3536

36-
# Timestamp bucket indicating when logs were last collected
37+
# Timestamp bucket indicating when logs were last collected.
3738
attr_reader :logs_last_collected
3839

39-
# Whether logs have been seen from any index
40+
# Whether logs for this content pack have been seen in any Datadog index within the last 72 hours.
4041
attr_reader :logs_seen_from_any_index
4142

42-
# The current status of a content pack
43+
# The current operational status of a content pack.
4344
attr_reader :state
4445

4546
attr_accessor :additional_properties

lib/datadog_api_client/v2/models/security_monitoring_content_pack_state_meta.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class SecurityMonitoringContentPackStateMeta
2424
# Whether the cloud SIEM index configuration is incorrect at the organization level
2525
attr_reader :cloud_siem_index_incorrect
2626

27-
# The SIEM pricing model (SKU) for the organization
27+
# The Cloud SIEM pricing model (SKU) for the organization.
2828
attr_reader :sku
2929

3030
attr_accessor :additional_properties

lib/datadog_api_client/v2/models/security_monitoring_content_pack_status.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The current status of a content pack
20+
# The current operational status of a content pack.
2121
class SecurityMonitoringContentPackStatus
2222
include BaseEnumModel
2323

lib/datadog_api_client/v2/models/security_monitoring_content_pack_timestamp_bucket.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# Timestamp bucket indicating when logs were last collected
20+
# Timestamp bucket indicating when logs were last collected.
2121
class SecurityMonitoringContentPackTimestampBucket
2222
include BaseEnumModel
2323

lib/datadog_api_client/v2/models/security_monitoring_sku.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The SIEM pricing model (SKU) for the organization
20+
# The Cloud SIEM pricing model (SKU) for the organization.
2121
class SecurityMonitoringSKU
2222
include BaseEnumModel
2323

0 commit comments

Comments
 (0)