Skip to content

Commit 135d239

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 07b13d4 of spec repo
1 parent 87532e1 commit 135d239

9 files changed

Lines changed: 160 additions & 51 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 84 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -60787,7 +60787,11 @@ components:
6078760787
- DONE
6078860788
- TIMEOUT
6078960789
SecurityMonitoringContentPackActivation:
60790-
description: The activation status of a content pack
60790+
description: |-
60791+
The activation lifecycle state of a content pack:
60792+
- `never_activated`: Pack has never been activated for this organization.
60793+
- `activated`: Pack is currently active.
60794+
- `deactivated`: Pack was previously activated but is now deactivated.
6079160795
enum:
6079260796
- never_activated
6079360797
- activated
@@ -60799,7 +60803,13 @@ components:
6079960803
- ACTIVATED
6080060804
- DEACTIVATED
6080160805
SecurityMonitoringContentPackIntegrationStatus:
60802-
description: The installation status of the related integration
60806+
description: |-
60807+
The installation status of the related Datadog integration:
60808+
- `installed`: Integration is fully installed.
60809+
- `available`: Integration exists in catalog but not installed.
60810+
- `partially_installed`: Integration is partially configured.
60811+
- `detected`: Integration detected (for example, logs flowing) but not explicitly installed.
60812+
- `error`: Integration in error state.
6080360813
enum:
6080460814
- installed
6080560815
- available
@@ -60897,7 +60907,14 @@ components:
6089760907
- meta
6089860908
type: object
6089960909
SecurityMonitoringContentPackStatus:
60900-
description: The current status of a content pack
60910+
description: |-
60911+
The current operational status of a content pack:
60912+
- `install`: Content pack not yet activated; awaiting user action.
60913+
- `activate`: Pack installed/configured but not yet activated by user.
60914+
- `initializing`: Activation in progress; logs pipeline being configured.
60915+
- `active`: Pack is fully operational and receiving logs.
60916+
- `warning`: Pack activated but potential issues detected.
60917+
- `broken`: Pack is activated but not functioning correctly.
6090160918
enum:
6090260919
- install
6090360920
- activate
@@ -60915,7 +60932,13 @@ components:
6091560932
- WARNING
6091660933
- BROKEN
6091760934
SecurityMonitoringContentPackTimestampBucket:
60918-
description: Timestamp bucket indicating when logs were last collected
60935+
description: |-
60936+
Timestamp bucket indicating when logs were last collected for a content pack:
60937+
- `not_seen`: No logs observed.
60938+
- `within_24_hours`: Logs seen in the last 24 hours.
60939+
- `within_24_to_72_hours`: Logs seen 24 to 72 hours ago.
60940+
- `over_72h_to_30d`: Logs seen 3 to 30 days ago.
60941+
- `over_30d`: Logs last seen more than 30 days ago.
6091960942
enum:
6092060943
- not_seen
6092160944
- within_24_hours
@@ -62014,7 +62037,11 @@ components:
6201462037
- $ref: "#/components/schemas/SecurityMonitoringSignalRulePayload"
6201562038
- $ref: "#/components/schemas/CloudConfigurationRulePayload"
6201662039
SecurityMonitoringSKU:
62017-
description: The SIEM pricing model (SKU) for the organization
62040+
description: |-
62041+
The SIEM pricing model (SKU) for the organization:
62042+
- `per_gb_analyzed`: Legacy per-GB analyzed pricing.
62043+
- `per_event_in_siem_index_2023`: 2023 per-indexed-event pricing.
62044+
- `add_on_2024`: 2024 add-on pricing.
6201862045
enum:
6201962046
- per_gb_analyzed
6202062047
- per_event_in_siem_index_2023
@@ -111563,8 +111590,13 @@ paths:
111563111590
get:
111564111591
description: |-
111565111592
Get the activation and configuration states for all security monitoring content packs.
111566-
This endpoint returns status information about each content pack including activation state,
111567-
integration status, and log collection status.
111593+
111594+
Each content pack state includes:
111595+
- **Activation state**: whether the pack has been activated (`never_activated`, `activated`, or `deactivated`).
111596+
- **Operational status**: current health of the pack (`install`, `activate`, `initializing`, `active`, `warning`, or `broken`).
111597+
- **Log ingestion signals**: whether logs have been seen from any index and how recently they were last collected.
111598+
- **Configuration health**: whether the Cloud SIEM index is correctly configured and whether filters are set up for the logs.
111599+
- **Integration status**: whether the relevant Datadog integration is installed.
111568111600
operationId: GetContentPacksStates
111569111601
responses:
111570111602
"200":
@@ -111574,11 +111606,7 @@ paths:
111574111606
$ref: "#/components/schemas/SecurityMonitoringContentPackStatesResponse"
111575111607
description: OK
111576111608
"403":
111577-
content:
111578-
application/json:
111579-
schema:
111580-
$ref: "#/components/schemas/JSONAPIErrorResponse"
111581-
description: Forbidden
111609+
$ref: "#/components/responses/NotAuthorizedResponse"
111582111610
"404":
111583111611
content:
111584111612
application/json:
@@ -111587,21 +111615,33 @@ paths:
111587111615
description: Not Found
111588111616
"429":
111589111617
$ref: "#/components/responses/TooManyRequestsResponse"
111618+
security:
111619+
- apiKeyAuth: []
111620+
appKeyAuth: []
111621+
- AuthZ:
111622+
- security_monitoring_filters_read
111590111623
summary: Get content pack states
111591111624
tags:
111592111625
- Security Monitoring
111626+
"x-permission":
111627+
operator: OR
111628+
permissions:
111629+
- security_monitoring_filters_read
111630+
- logs_read_index_data
111593111631
x-unstable: |-
111594111632
**Note**: This endpoint is in preview and is subject to change.
111595111633
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
111596111634
/api/v2/security_monitoring/content_packs/{content_pack_id}/activate:
111597111635
put:
111598111636
description: |-
111599-
Activate a security monitoring content pack. This operation configures the necessary
111600-
log filters or security filters depending on the pricing model and updates the content
111601-
pack activation state.
111637+
Activate a security monitoring content pack for the authenticated organization.
111638+
111639+
Activation creates the underlying SIEM security filters and index routing configuration
111640+
for the content pack's log source. The Security Monitoring product must be enabled
111641+
for the organization.
111602111642
operationId: ActivateContentPack
111603111643
parameters:
111604-
- description: The ID of the content pack to activate.
111644+
- description: The ID of the content pack to activate (for example, `aws-cloudtrail`).
111605111645
in: path
111606111646
name: content_pack_id
111607111647
required: true
@@ -111612,11 +111652,7 @@ paths:
111612111652
"202":
111613111653
description: Accepted
111614111654
"403":
111615-
content:
111616-
application/json:
111617-
schema:
111618-
$ref: "#/components/schemas/JSONAPIErrorResponse"
111619-
description: Forbidden
111655+
$ref: "#/components/responses/NotAuthorizedResponse"
111620111656
"404":
111621111657
content:
111622111658
application/json:
@@ -111625,20 +111661,33 @@ paths:
111625111661
description: Not Found
111626111662
"429":
111627111663
$ref: "#/components/responses/TooManyRequestsResponse"
111664+
security:
111665+
- apiKeyAuth: []
111666+
appKeyAuth: []
111667+
- AuthZ:
111668+
- security_monitoring_filters_write
111628111669
summary: Activate content pack
111629111670
tags:
111630111671
- Security Monitoring
111672+
"x-permission":
111673+
operator: OR
111674+
permissions:
111675+
- security_monitoring_filters_write
111676+
- logs_modify_indexes
111631111677
x-unstable: |-
111632111678
**Note**: This endpoint is in preview and is subject to change.
111633111679
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
111634111680
/api/v2/security_monitoring/content_packs/{content_pack_id}/deactivate:
111635111681
put:
111636111682
description: |-
111637-
Deactivate a security monitoring content pack. This operation removes the content pack's
111638-
configuration from log filters or security filters and updates the content pack activation state.
111683+
Deactivate a security monitoring content pack for the authenticated organization.
111684+
111685+
Deactivation removes the SIEM security filters and index routing configuration
111686+
for the content pack's log source. The Security Monitoring product must be enabled
111687+
for the organization.
111639111688
operationId: DeactivateContentPack
111640111689
parameters:
111641-
- description: The ID of the content pack to deactivate.
111690+
- description: The ID of the content pack to deactivate (for example, `aws-cloudtrail`).
111642111691
in: path
111643111692
name: content_pack_id
111644111693
required: true
@@ -111649,11 +111698,7 @@ paths:
111649111698
"202":
111650111699
description: Accepted
111651111700
"403":
111652-
content:
111653-
application/json:
111654-
schema:
111655-
$ref: "#/components/schemas/JSONAPIErrorResponse"
111656-
description: Forbidden
111701+
$ref: "#/components/responses/NotAuthorizedResponse"
111657111702
"404":
111658111703
content:
111659111704
application/json:
@@ -111662,9 +111707,19 @@ paths:
111662111707
description: Not Found
111663111708
"429":
111664111709
$ref: "#/components/responses/TooManyRequestsResponse"
111710+
security:
111711+
- apiKeyAuth: []
111712+
appKeyAuth: []
111713+
- AuthZ:
111714+
- security_monitoring_filters_write
111665111715
summary: Deactivate content pack
111666111716
tags:
111667111717
- Security Monitoring
111718+
"x-permission":
111719+
operator: OR
111720+
permissions:
111721+
- security_monitoring_filters_write
111722+
- logs_modify_indexes
111668111723
x-unstable: |-
111669111724
**Note**: This endpoint is in preview and is subject to change.
111670111725
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: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,13 @@ 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
37-
# log filters or security filters depending on the pricing model and updates the content
38-
# pack activation state.
36+
# Activate a security monitoring content pack for the authenticated organization.
3937
#
40-
# @param content_pack_id [String] The ID of the content pack to activate.
38+
# Activation creates the underlying SIEM security filters and index routing configuration
39+
# for the content pack's log source. The Security Monitoring product must be enabled
40+
# for the organization.
41+
#
42+
# @param content_pack_id [String] The ID of the content pack to activate (for example, `aws-cloudtrail`).
4143
# @param opts [Hash] the optional parameters
4244
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
4345
def activate_content_pack_with_http_info(content_pack_id, opts = {})
@@ -76,7 +78,7 @@ def activate_content_pack_with_http_info(content_pack_id, opts = {})
7678
return_type = opts[:debug_return_type]
7779

7880
# auth_names
79-
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
81+
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
8082

8183
new_options = opts.merge(
8284
:operation => :activate_content_pack,
@@ -1348,10 +1350,13 @@ def deactivate_content_pack(content_pack_id, opts = {})
13481350

13491351
# Deactivate content pack.
13501352
#
1351-
# Deactivate a security monitoring content pack. This operation removes the content pack's
1352-
# configuration from log filters or security filters and updates the content pack activation state.
1353+
# Deactivate a security monitoring content pack for the authenticated organization.
13531354
#
1354-
# @param content_pack_id [String] The ID of the content pack to deactivate.
1355+
# Deactivation removes the SIEM security filters and index routing configuration
1356+
# for the content pack's log source. The Security Monitoring product must be enabled
1357+
# for the organization.
1358+
#
1359+
# @param content_pack_id [String] The ID of the content pack to deactivate (for example, `aws-cloudtrail`).
13551360
# @param opts [Hash] the optional parameters
13561361
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
13571362
def deactivate_content_pack_with_http_info(content_pack_id, opts = {})
@@ -1390,7 +1395,7 @@ def deactivate_content_pack_with_http_info(content_pack_id, opts = {})
13901395
return_type = opts[:debug_return_type]
13911396

13921397
# auth_names
1393-
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
1398+
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
13941399

13951400
new_options = opts.merge(
13961401
:operation => :deactivate_content_pack,
@@ -2236,8 +2241,13 @@ def get_content_packs_states(opts = {})
22362241
# Get content pack states.
22372242
#
22382243
# 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.
2244+
#
2245+
# Each content pack state includes:
2246+
# - **Activation state**: whether the pack has been activated (`never_activated`, `activated`, or `deactivated`).
2247+
# - **Operational status**: current health of the pack (`install`, `activate`, `initializing`, `active`, `warning`, or `broken`).
2248+
# - **Log ingestion signals**: whether logs have been seen from any index and how recently they were last collected.
2249+
# - **Configuration health**: whether the Cloud SIEM index is correctly configured and whether filters are set up for the logs.
2250+
# - **Integration status**: whether the relevant Datadog integration is installed.
22412251
#
22422252
# @param opts [Hash] the optional parameters
22432253
# @return [Array<(SecurityMonitoringContentPackStatesResponse, Integer, Hash)>] SecurityMonitoringContentPackStatesResponse data, response status code and response headers
@@ -2273,7 +2283,7 @@ def get_content_packs_states_with_http_info(opts = {})
22732283
return_type = opts[:debug_return_type] || 'SecurityMonitoringContentPackStatesResponse'
22742284

22752285
# auth_names
2276-
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
2286+
auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
22772287

22782288
new_options = opts.merge(
22792289
:operation => :get_content_packs_states,

lib/datadog_api_client/v2/models/security_monitoring_content_pack_activation.rb

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

1919
module DatadogAPIClient::V2
20-
# The activation status of a content pack
20+
# The activation lifecycle state of a content pack:
21+
# - `never_activated`: Pack has never been activated for this organization.
22+
# - `activated`: Pack is currently active.
23+
# - `deactivated`: Pack was previously activated but is now deactivated.
2124
class SecurityMonitoringContentPackActivation
2225
include BaseEnumModel
2326

lib/datadog_api_client/v2/models/security_monitoring_content_pack_integration_status.rb

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

1919
module DatadogAPIClient::V2
20-
# The installation status of the related integration
20+
# The installation status of the related Datadog integration:
21+
# - `installed`: Integration is fully installed.
22+
# - `available`: Integration exists in catalog but not installed.
23+
# - `partially_installed`: Integration is partially configured.
24+
# - `detected`: Integration detected (for example, logs flowing) but not explicitly installed.
25+
# - `error`: Integration in error state.
2126
class SecurityMonitoringContentPackIntegrationStatus
2227
include BaseEnumModel
2328

lib/datadog_api_client/v2/models/security_monitoring_content_pack_state_attributes.rb

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,41 @@ 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 lifecycle state of a content pack:
28+
# - `never_activated`: Pack has never been activated for this organization.
29+
# - `activated`: Pack is currently active.
30+
# - `deactivated`: Pack was previously activated but is now deactivated.
2831
attr_reader :cp_activation
2932

3033
# Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs
3134
attr_reader :filters_configured_for_logs
3235

33-
# The installation status of the related integration
36+
# The installation status of the related Datadog integration:
37+
# - `installed`: Integration is fully installed.
38+
# - `available`: Integration exists in catalog but not installed.
39+
# - `partially_installed`: Integration is partially configured.
40+
# - `detected`: Integration detected (for example, logs flowing) but not explicitly installed.
41+
# - `error`: Integration in error state.
3442
attr_accessor :integration_installed_status
3543

36-
# Timestamp bucket indicating when logs were last collected
44+
# Timestamp bucket indicating when logs were last collected for a content pack:
45+
# - `not_seen`: No logs observed.
46+
# - `within_24_hours`: Logs seen in the last 24 hours.
47+
# - `within_24_to_72_hours`: Logs seen 24 to 72 hours ago.
48+
# - `over_72h_to_30d`: Logs seen 3 to 30 days ago.
49+
# - `over_30d`: Logs last seen more than 30 days ago.
3750
attr_reader :logs_last_collected
3851

3952
# Whether logs have been seen from any index
4053
attr_reader :logs_seen_from_any_index
4154

42-
# The current status of a content pack
55+
# The current operational status of a content pack:
56+
# - `install`: Content pack not yet activated; awaiting user action.
57+
# - `activate`: Pack installed/configured but not yet activated by user.
58+
# - `initializing`: Activation in progress; logs pipeline being configured.
59+
# - `active`: Pack is fully operational and receiving logs.
60+
# - `warning`: Pack activated but potential issues detected.
61+
# - `broken`: Pack is activated but not functioning correctly.
4362
attr_reader :state
4463

4564
attr_accessor :additional_properties

lib/datadog_api_client/v2/models/security_monitoring_content_pack_state_meta.rb

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ 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 SIEM pricing model (SKU) for the organization:
28+
# - `per_gb_analyzed`: Legacy per-GB analyzed pricing.
29+
# - `per_event_in_siem_index_2023`: 2023 per-indexed-event pricing.
30+
# - `add_on_2024`: 2024 add-on pricing.
2831
attr_reader :sku
2932

3033
attr_accessor :additional_properties

lib/datadog_api_client/v2/models/security_monitoring_content_pack_status.rb

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,13 @@
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:
21+
# - `install`: Content pack not yet activated; awaiting user action.
22+
# - `activate`: Pack installed/configured but not yet activated by user.
23+
# - `initializing`: Activation in progress; logs pipeline being configured.
24+
# - `active`: Pack is fully operational and receiving logs.
25+
# - `warning`: Pack activated but potential issues detected.
26+
# - `broken`: Pack is activated but not functioning correctly.
2127
class SecurityMonitoringContentPackStatus
2228
include BaseEnumModel
2329

0 commit comments

Comments
 (0)