Skip to content

Commit 58cd207

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit b82392a of spec repo
1 parent 991f189 commit 58cd207

9 files changed

+193
-57
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 96 additions & 32 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
@@ -60818,21 +60828,24 @@ components:
6081860828
description: Attributes of a content pack state
6081960829
properties:
6082060830
cloud_siem_index_incorrect:
60821-
description: Whether the cloud SIEM index configuration is incorrect (only applies to certain pricing models)
60831+
description: >-
60832+
Whether the Cloud SIEM index is incorrectly configured at the content pack level, for example positioned below the catch-all `*` index so it cannot receive logs. Only meaningful for Standalone SKU. When `true`, the content pack status is `broken` regardless of other fields.
6082260833
example: false
6082360834
type: boolean
6082460835
cp_activation:
6082560836
$ref: "#/components/schemas/SecurityMonitoringContentPackActivation"
6082660837
filters_configured_for_logs:
60827-
description: Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs
60838+
description: >-
60839+
Whether the content pack's index query (Legacy SKU) or security filter (Standalone/Add-On SKU) is present and correctly configured to route logs into Cloud SIEM.
6082860840
example: true
6082960841
type: boolean
6083060842
integration_installed_status:
6083160843
$ref: "#/components/schemas/SecurityMonitoringContentPackIntegrationStatus"
6083260844
logs_last_collected:
6083360845
$ref: "#/components/schemas/SecurityMonitoringContentPackTimestampBucket"
6083460846
logs_seen_from_any_index:
60835-
description: Whether logs have been seen from any index
60847+
description: >-
60848+
Whether logs for this content pack have been seen in any Datadog index within the last 72 hours, regardless of whether the Cloud SIEM index or security filter is configured. Used to distinguish `install` (no logs anywhere) from `activate` (logs detected but pack not yet enabled).
6083660849
example: true
6083760850
type: boolean
6083860851
state:
@@ -60897,7 +60910,19 @@ components:
6089760910
- meta
6089860911
type: object
6089960912
SecurityMonitoringContentPackStatus:
60900-
description: The current status of a content pack
60913+
description: |-
60914+
The current operational status of a content pack:
60915+
- `install`: Pack is not activated and no logs have been detected in any index within the last 72 hours.
60916+
- `activate`: Pack is not activated but logs are already flowing into a Datadog index, indicating the integration
60917+
is sending data. Activating the pack will route those logs through Cloud SIEM.
60918+
- `initializing`: Pack has been activated and the security filter or index query is configured correctly,
60919+
but no logs have been received yet. Typically a transient state after first activation.
60920+
- `active`: Pack is activated and logs were received within the last 24 hours.
60921+
- `warning`: Pack is activated but degraded — either the integration tile is not installed and no logs have
60922+
been seen, or logs were last seen between 24 and 72 hours ago.
60923+
- `broken`: Pack is activated but not functioning — logs have not been seen for over 72 hours, the security
60924+
filter or index query is missing, or the Cloud SIEM index is positioned below the catch-all `*` index
60925+
(Standalone SKU only).
6090160926
enum:
6090260927
- install
6090360928
- activate
@@ -60915,7 +60940,14 @@ components:
6091560940
- WARNING
6091660941
- BROKEN
6091760942
SecurityMonitoringContentPackTimestampBucket:
60918-
description: Timestamp bucket indicating when logs were last collected
60943+
description: |-
60944+
Timestamp bucket indicating when logs were last collected through the content pack's Cloud SIEM filter or index query.
60945+
This field drives the `state` value for activated packs:
60946+
- `not_seen`: No logs observed through Cloud SIEM. Contributes to `initializing`, `warning`, or `broken` state.
60947+
- `within_24_hours`: Logs received within the last 24 hours. Contributes to `active` state.
60948+
- `within_24_to_72_hours`: Logs last seen 24 to 72 hours ago. Contributes to `warning` state.
60949+
- `over_72h_to_30d`: Logs last seen 3 to 30 days ago. Contributes to `broken` state.
60950+
- `over_30d`: Logs last seen more than 30 days ago. Contributes to `install` (Legacy SKU) or `broken` state.
6091960951
enum:
6092060952
- not_seen
6092160953
- within_24_hours
@@ -62014,7 +62046,11 @@ components:
6201462046
- $ref: "#/components/schemas/SecurityMonitoringSignalRulePayload"
6201562047
- $ref: "#/components/schemas/CloudConfigurationRulePayload"
6201662048
SecurityMonitoringSKU:
62017-
description: The SIEM pricing model (SKU) for the organization
62049+
description: |-
62050+
The SIEM pricing model (SKU) for the organization:
62051+
- `per_gb_analyzed`: Legacy per-GB analyzed pricing.
62052+
- `per_event_in_siem_index_2023`: 2023 per-indexed-event pricing.
62053+
- `add_on_2024`: 2024 add-on pricing.
6201862054
enum:
6201962055
- per_gb_analyzed
6202062056
- per_event_in_siem_index_2023
@@ -111563,8 +111599,13 @@ paths:
111563111599
get:
111564111600
description: |-
111565111601
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.
111602+
111603+
Each content pack state includes:
111604+
- **Activation state**: whether the pack has been activated (`never_activated`, `activated`, or `deactivated`).
111605+
- **Operational status**: current health of the pack (`install`, `activate`, `initializing`, `active`, `warning`, or `broken`).
111606+
- **Log ingestion signals**: whether logs have been seen from any index and how recently they were last collected.
111607+
- **Configuration health**: whether the Cloud SIEM index is correctly configured and whether filters are set up for the logs.
111608+
- **Integration status**: whether the relevant Datadog integration is installed.
111568111609
operationId: GetContentPacksStates
111569111610
responses:
111570111611
"200":
@@ -111574,11 +111615,7 @@ paths:
111574111615
$ref: "#/components/schemas/SecurityMonitoringContentPackStatesResponse"
111575111616
description: OK
111576111617
"403":
111577-
content:
111578-
application/json:
111579-
schema:
111580-
$ref: "#/components/schemas/JSONAPIErrorResponse"
111581-
description: Forbidden
111618+
$ref: "#/components/responses/NotAuthorizedResponse"
111582111619
"404":
111583111620
content:
111584111621
application/json:
@@ -111587,21 +111624,33 @@ paths:
111587111624
description: Not Found
111588111625
"429":
111589111626
$ref: "#/components/responses/TooManyRequestsResponse"
111627+
security:
111628+
- apiKeyAuth: []
111629+
appKeyAuth: []
111630+
- AuthZ:
111631+
- security_monitoring_filters_read
111590111632
summary: Get content pack states
111591111633
tags:
111592111634
- Security Monitoring
111635+
"x-permission":
111636+
operator: OR
111637+
permissions:
111638+
- security_monitoring_filters_read
111639+
- logs_read_index_data
111593111640
x-unstable: |-
111594111641
**Note**: This endpoint is in preview and is subject to change.
111595111642
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
111596111643
/api/v2/security_monitoring/content_packs/{content_pack_id}/activate:
111597111644
put:
111598111645
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.
111646+
Activate a security monitoring content pack for the authenticated organization.
111647+
111648+
Activation creates the underlying SIEM security filters and index routing configuration
111649+
for the content pack's log source. The Security Monitoring product must be enabled
111650+
for the organization.
111602111651
operationId: ActivateContentPack
111603111652
parameters:
111604-
- description: The ID of the content pack to activate.
111653+
- description: The ID of the content pack to activate (for example, `aws-cloudtrail`).
111605111654
in: path
111606111655
name: content_pack_id
111607111656
required: true
@@ -111612,11 +111661,7 @@ paths:
111612111661
"202":
111613111662
description: Accepted
111614111663
"403":
111615-
content:
111616-
application/json:
111617-
schema:
111618-
$ref: "#/components/schemas/JSONAPIErrorResponse"
111619-
description: Forbidden
111664+
$ref: "#/components/responses/NotAuthorizedResponse"
111620111665
"404":
111621111666
content:
111622111667
application/json:
@@ -111625,20 +111670,33 @@ paths:
111625111670
description: Not Found
111626111671
"429":
111627111672
$ref: "#/components/responses/TooManyRequestsResponse"
111673+
security:
111674+
- apiKeyAuth: []
111675+
appKeyAuth: []
111676+
- AuthZ:
111677+
- security_monitoring_filters_write
111628111678
summary: Activate content pack
111629111679
tags:
111630111680
- Security Monitoring
111681+
"x-permission":
111682+
operator: OR
111683+
permissions:
111684+
- security_monitoring_filters_write
111685+
- logs_modify_indexes
111631111686
x-unstable: |-
111632111687
**Note**: This endpoint is in preview and is subject to change.
111633111688
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
111634111689
/api/v2/security_monitoring/content_packs/{content_pack_id}/deactivate:
111635111690
put:
111636111691
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.
111692+
Deactivate a security monitoring content pack for the authenticated organization.
111693+
111694+
Deactivation removes the SIEM security filters and index routing configuration
111695+
for the content pack's log source. The Security Monitoring product must be enabled
111696+
for the organization.
111639111697
operationId: DeactivateContentPack
111640111698
parameters:
111641-
- description: The ID of the content pack to deactivate.
111699+
- description: The ID of the content pack to deactivate (for example, `aws-cloudtrail`).
111642111700
in: path
111643111701
name: content_pack_id
111644111702
required: true
@@ -111649,11 +111707,7 @@ paths:
111649111707
"202":
111650111708
description: Accepted
111651111709
"403":
111652-
content:
111653-
application/json:
111654-
schema:
111655-
$ref: "#/components/schemas/JSONAPIErrorResponse"
111656-
description: Forbidden
111710+
$ref: "#/components/responses/NotAuthorizedResponse"
111657111711
"404":
111658111712
content:
111659111713
application/json:
@@ -111662,9 +111716,19 @@ paths:
111662111716
description: Not Found
111663111717
"429":
111664111718
$ref: "#/components/responses/TooManyRequestsResponse"
111719+
security:
111720+
- apiKeyAuth: []
111721+
appKeyAuth: []
111722+
- AuthZ:
111723+
- security_monitoring_filters_write
111665111724
summary: Deactivate content pack
111666111725
tags:
111667111726
- Security Monitoring
111727+
"x-permission":
111728+
operator: OR
111729+
permissions:
111730+
- security_monitoring_filters_write
111731+
- logs_modify_indexes
111668111732
x-unstable: |-
111669111733
**Note**: This endpoint is in preview and is subject to change.
111670111734
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).

src/datadog_api_client/v2/api/security_monitoring_api.py

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ def __init__(self, api_client=None):
174174
self._activate_content_pack_endpoint = _Endpoint(
175175
settings={
176176
"response_type": None,
177-
"auth": ["apiKeyAuth", "appKeyAuth"],
177+
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
178178
"endpoint_path": "/api/v2/security_monitoring/content_packs/{content_pack_id}/activate",
179179
"operation_id": "activate_content_pack",
180180
"http_method": "PUT",
@@ -569,7 +569,7 @@ def __init__(self, api_client=None):
569569
self._deactivate_content_pack_endpoint = _Endpoint(
570570
settings={
571571
"response_type": None,
572-
"auth": ["apiKeyAuth", "appKeyAuth"],
572+
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
573573
"endpoint_path": "/api/v2/security_monitoring/content_packs/{content_pack_id}/deactivate",
574574
"operation_id": "deactivate_content_pack",
575575
"http_method": "PUT",
@@ -880,7 +880,7 @@ def __init__(self, api_client=None):
880880
self._get_content_packs_states_endpoint = _Endpoint(
881881
settings={
882882
"response_type": (SecurityMonitoringContentPackStatesResponse,),
883-
"auth": ["apiKeyAuth", "appKeyAuth"],
883+
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
884884
"endpoint_path": "/api/v2/security_monitoring/content_packs/states",
885885
"operation_id": "get_content_packs_states",
886886
"http_method": "GET",
@@ -2777,11 +2777,13 @@ def activate_content_pack(
27772777
) -> None:
27782778
"""Activate content pack.
27792779
2780-
Activate a security monitoring content pack. This operation configures the necessary
2781-
log filters or security filters depending on the pricing model and updates the content
2782-
pack activation state.
2780+
Activate a security monitoring content pack for the authenticated organization.
2781+
2782+
Activation creates the underlying SIEM security filters and index routing configuration
2783+
for the content pack's log source. The Security Monitoring product must be enabled
2784+
for the organization.
27832785
2784-
:param content_pack_id: The ID of the content pack to activate.
2786+
:param content_pack_id: The ID of the content pack to activate (for example, ``aws-cloudtrail`` ).
27852787
:type content_pack_id: str
27862788
:rtype: None
27872789
"""
@@ -3134,10 +3136,13 @@ def deactivate_content_pack(
31343136
) -> None:
31353137
"""Deactivate content pack.
31363138
3137-
Deactivate a security monitoring content pack. This operation removes the content pack's
3138-
configuration from log filters or security filters and updates the content pack activation state.
3139+
Deactivate a security monitoring content pack for the authenticated organization.
3140+
3141+
Deactivation removes the SIEM security filters and index routing configuration
3142+
for the content pack's log source. The Security Monitoring product must be enabled
3143+
for the organization.
31393144
3140-
:param content_pack_id: The ID of the content pack to deactivate.
3145+
:param content_pack_id: The ID of the content pack to deactivate (for example, ``aws-cloudtrail`` ).
31413146
:type content_pack_id: str
31423147
:rtype: None
31433148
"""
@@ -3376,8 +3381,14 @@ def get_content_packs_states(
33763381
"""Get content pack states.
33773382
33783383
Get the activation and configuration states for all security monitoring content packs.
3379-
This endpoint returns status information about each content pack including activation state,
3380-
integration status, and log collection status.
3384+
3385+
Each content pack state includes:
3386+
3387+
* **Activation state** : whether the pack has been activated ( ``never_activated`` , ``activated`` , or ``deactivated`` ).
3388+
* **Operational status** : current health of the pack ( ``install`` , ``activate`` , ``initializing`` , ``active`` , ``warning`` , or ``broken`` ).
3389+
* **Log ingestion signals** : whether logs have been seen from any index and how recently they were last collected.
3390+
* **Configuration health** : whether the Cloud SIEM index is correctly configured and whether filters are set up for the logs.
3391+
* **Integration status** : whether the relevant Datadog integration is installed.
33813392
33823393
:rtype: SecurityMonitoringContentPackStatesResponse
33833394
"""

src/datadog_api_client/v2/model/security_monitoring_content_pack_activation.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@
1414

1515
class SecurityMonitoringContentPackActivation(ModelSimple):
1616
"""
17-
The activation status of a content pack
17+
The activation lifecycle state of a content pack:
18+
- `never_activated`: Pack has never been activated for this organization.
19+
- `activated`: Pack is currently active.
20+
- `deactivated`: Pack was previously activated but is now deactivated.
1821
1922
:param value: Must be one of ["never_activated", "activated", "deactivated"].
2023
:type value: str

src/datadog_api_client/v2/model/security_monitoring_content_pack_integration_status.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,12 @@
1414

1515
class SecurityMonitoringContentPackIntegrationStatus(ModelSimple):
1616
"""
17-
The installation status of the related integration
17+
The installation status of the related Datadog integration:
18+
- `installed`: Integration is fully installed.
19+
- `available`: Integration exists in catalog but not installed.
20+
- `partially_installed`: Integration is partially configured.
21+
- `detected`: Integration detected (for example, logs flowing) but not explicitly installed.
22+
- `error`: Integration in error state.
1823
1924
:param value: Must be one of ["installed", "available", "partially_installed", "detected", "error"].
2025
:type value: str

0 commit comments

Comments
 (0)