Skip to content

Commit 02e1fab

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 8c9edef of spec repo
1 parent 991f189 commit 02e1fab

9 files changed

+86
-52
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 53 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -60787,7 +60787,7 @@ components:
6078760787
- DONE
6078860788
- TIMEOUT
6078960789
SecurityMonitoringContentPackActivation:
60790-
description: The activation status of a content pack
60790+
description: The activation lifecycle state of a content pack.
6079160791
enum:
6079260792
- never_activated
6079360793
- activated
@@ -60799,7 +60799,7 @@ components:
6079960799
- ACTIVATED
6080060800
- DEACTIVATED
6080160801
SecurityMonitoringContentPackIntegrationStatus:
60802-
description: The installation status of the related integration
60802+
description: The installation status of the related Datadog integration.
6080360803
enum:
6080460804
- installed
6080560805
- available
@@ -60824,15 +60824,16 @@ components:
6082460824
cp_activation:
6082560825
$ref: "#/components/schemas/SecurityMonitoringContentPackActivation"
6082660826
filters_configured_for_logs:
60827-
description: Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs
60827+
description: Whether filters (Security Filters or Index Query depending on the pricing model) are present and correctly configured to route logs into Cloud SIEM.
6082860828
example: true
6082960829
type: boolean
6083060830
integration_installed_status:
6083160831
$ref: "#/components/schemas/SecurityMonitoringContentPackIntegrationStatus"
6083260832
logs_last_collected:
6083360833
$ref: "#/components/schemas/SecurityMonitoringContentPackTimestampBucket"
6083460834
logs_seen_from_any_index:
60835-
description: Whether logs have been seen from any index
60835+
description: >-
60836+
Whether logs for this content pack have been seen in any Datadog index within the last 72 hours, regardless of whether the Cloud SIEM filter is configured.
6083660837
example: true
6083760838
type: boolean
6083860839
state:
@@ -60897,7 +60898,14 @@ components:
6089760898
- meta
6089860899
type: object
6089960900
SecurityMonitoringContentPackStatus:
60900-
description: The current status of a content pack
60901+
description: |-
60902+
The current operational status of a content pack:
60903+
- `install`: Not activated; no logs detected in the last 72 hours.
60904+
- `activate`: Not activated; logs are flowing into a Datadog index but not yet routed through Cloud SIEM.
60905+
- `initializing`: Activated; awaiting first log ingestion.
60906+
- `active`: Activated; logs received within the last 24 hours.
60907+
- `warning`: Activated; integration not installed or logs last seen 24 to 72 hours ago.
60908+
- `broken`: Activated; no logs for over 72 hours, filter missing, or Cloud SIEM index incorrectly ordered.
6090160909
enum:
6090260910
- install
6090360911
- activate
@@ -60915,7 +60923,7 @@ components:
6091560923
- WARNING
6091660924
- BROKEN
6091760925
SecurityMonitoringContentPackTimestampBucket:
60918-
description: Timestamp bucket indicating when logs were last collected
60926+
description: When logs were last collected through the content pack's Cloud SIEM filter or index query.
6091960927
enum:
6092060928
- not_seen
6092160929
- within_24_hours
@@ -62014,7 +62022,7 @@ components:
6201462022
- $ref: "#/components/schemas/SecurityMonitoringSignalRulePayload"
6201562023
- $ref: "#/components/schemas/CloudConfigurationRulePayload"
6201662024
SecurityMonitoringSKU:
62017-
description: The SIEM pricing model (SKU) for the organization
62025+
description: The Cloud SIEM pricing model (SKU) for the organization.
6201862026
enum:
6201962027
- per_gb_analyzed
6202062028
- per_event_in_siem_index_2023
@@ -111561,10 +111569,7 @@ paths:
111561111569
- Security Monitoring
111562111570
/api/v2/security_monitoring/content_packs/states:
111563111571
get:
111564-
description: |-
111565-
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.
111572+
description: Get the activation and operational state for all Cloud SIEM content packs.
111568111573
operationId: GetContentPacksStates
111569111574
responses:
111570111575
"200":
@@ -111574,11 +111579,7 @@ paths:
111574111579
$ref: "#/components/schemas/SecurityMonitoringContentPackStatesResponse"
111575111580
description: OK
111576111581
"403":
111577-
content:
111578-
application/json:
111579-
schema:
111580-
$ref: "#/components/schemas/JSONAPIErrorResponse"
111581-
description: Forbidden
111582+
$ref: "#/components/responses/NotAuthorizedResponse"
111582111583
"404":
111583111584
content:
111584111585
application/json:
@@ -111587,21 +111588,31 @@ paths:
111587111588
description: Not Found
111588111589
"429":
111589111590
$ref: "#/components/responses/TooManyRequestsResponse"
111591+
security:
111592+
- apiKeyAuth: []
111593+
appKeyAuth: []
111594+
- AuthZ:
111595+
- security_monitoring_filters_read
111590111596
summary: Get content pack states
111591111597
tags:
111592111598
- Security Monitoring
111599+
"x-permission":
111600+
operator: OR
111601+
permissions:
111602+
- security_monitoring_filters_read
111603+
- logs_read_index_data
111593111604
x-unstable: |-
111594111605
**Note**: This endpoint is in preview and is subject to change.
111595111606
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
111596111607
/api/v2/security_monitoring/content_packs/{content_pack_id}/activate:
111597111608
put:
111598111609
description: |-
111599-
Activate a security monitoring content pack. This operation configures the necessary
111610+
Activate a Cloud SIEM content pack. This operation configures the necessary
111600111611
log filters or security filters depending on the pricing model and updates the content
111601111612
pack activation state.
111602111613
operationId: ActivateContentPack
111603111614
parameters:
111604-
- description: The ID of the content pack to activate.
111615+
- description: The ID of the content pack to activate (for example, `aws-cloudtrail`).
111605111616
in: path
111606111617
name: content_pack_id
111607111618
required: true
@@ -111612,11 +111623,7 @@ paths:
111612111623
"202":
111613111624
description: Accepted
111614111625
"403":
111615-
content:
111616-
application/json:
111617-
schema:
111618-
$ref: "#/components/schemas/JSONAPIErrorResponse"
111619-
description: Forbidden
111626+
$ref: "#/components/responses/NotAuthorizedResponse"
111620111627
"404":
111621111628
content:
111622111629
application/json:
@@ -111625,20 +111632,30 @@ paths:
111625111632
description: Not Found
111626111633
"429":
111627111634
$ref: "#/components/responses/TooManyRequestsResponse"
111635+
security:
111636+
- apiKeyAuth: []
111637+
appKeyAuth: []
111638+
- AuthZ:
111639+
- security_monitoring_filters_write
111628111640
summary: Activate content pack
111629111641
tags:
111630111642
- Security Monitoring
111643+
"x-permission":
111644+
operator: OR
111645+
permissions:
111646+
- security_monitoring_filters_write
111647+
- logs_modify_indexes
111631111648
x-unstable: |-
111632111649
**Note**: This endpoint is in preview and is subject to change.
111633111650
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
111634111651
/api/v2/security_monitoring/content_packs/{content_pack_id}/deactivate:
111635111652
put:
111636111653
description: |-
111637-
Deactivate a security monitoring content pack. This operation removes the content pack's
111654+
Deactivate a Cloud SIEM content pack. This operation removes the content pack's
111638111655
configuration from log filters or security filters and updates the content pack activation state.
111639111656
operationId: DeactivateContentPack
111640111657
parameters:
111641-
- description: The ID of the content pack to deactivate.
111658+
- description: The ID of the content pack to deactivate (for example, `aws-cloudtrail`).
111642111659
in: path
111643111660
name: content_pack_id
111644111661
required: true
@@ -111649,11 +111666,7 @@ paths:
111649111666
"202":
111650111667
description: Accepted
111651111668
"403":
111652-
content:
111653-
application/json:
111654-
schema:
111655-
$ref: "#/components/schemas/JSONAPIErrorResponse"
111656-
description: Forbidden
111669+
$ref: "#/components/responses/NotAuthorizedResponse"
111657111670
"404":
111658111671
content:
111659111672
application/json:
@@ -111662,9 +111675,19 @@ paths:
111662111675
description: Not Found
111663111676
"429":
111664111677
$ref: "#/components/responses/TooManyRequestsResponse"
111678+
security:
111679+
- apiKeyAuth: []
111680+
appKeyAuth: []
111681+
- AuthZ:
111682+
- security_monitoring_filters_write
111665111683
summary: Deactivate content pack
111666111684
tags:
111667111685
- Security Monitoring
111686+
"x-permission":
111687+
operator: OR
111688+
permissions:
111689+
- security_monitoring_filters_write
111690+
- logs_modify_indexes
111668111691
x-unstable: |-
111669111692
**Note**: This endpoint is in preview and is subject to change.
111670111693
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: 8 additions & 10 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,11 @@ def activate_content_pack(
27772777
) -> None:
27782778
"""Activate content pack.
27792779
2780-
Activate a security monitoring content pack. This operation configures the necessary
2780+
Activate a Cloud SIEM content pack. This operation configures the necessary
27812781
log filters or security filters depending on the pricing model and updates the content
27822782
pack activation state.
27832783
2784-
:param content_pack_id: The ID of the content pack to activate.
2784+
:param content_pack_id: The ID of the content pack to activate (for example, ``aws-cloudtrail`` ).
27852785
:type content_pack_id: str
27862786
:rtype: None
27872787
"""
@@ -3134,10 +3134,10 @@ def deactivate_content_pack(
31343134
) -> None:
31353135
"""Deactivate content pack.
31363136
3137-
Deactivate a security monitoring content pack. This operation removes the content pack's
3137+
Deactivate a Cloud SIEM content pack. This operation removes the content pack's
31383138
configuration from log filters or security filters and updates the content pack activation state.
31393139
3140-
:param content_pack_id: The ID of the content pack to deactivate.
3140+
:param content_pack_id: The ID of the content pack to deactivate (for example, ``aws-cloudtrail`` ).
31413141
:type content_pack_id: str
31423142
:rtype: None
31433143
"""
@@ -3375,9 +3375,7 @@ def get_content_packs_states(
33753375
) -> SecurityMonitoringContentPackStatesResponse:
33763376
"""Get content pack states.
33773377
3378-
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.
3378+
Get the activation and operational state for all Cloud SIEM content packs.
33813379
33823380
:rtype: SecurityMonitoringContentPackStatesResponse
33833381
"""

src/datadog_api_client/v2/model/security_monitoring_content_pack_activation.py

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

1515
class SecurityMonitoringContentPackActivation(ModelSimple):
1616
"""
17-
The activation status of a content pack
17+
The activation lifecycle state of a content pack.
1818
1919
:param value: Must be one of ["never_activated", "activated", "deactivated"].
2020
:type value: str

src/datadog_api_client/v2/model/security_monitoring_content_pack_integration_status.py

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

1515
class SecurityMonitoringContentPackIntegrationStatus(ModelSimple):
1616
"""
17-
The installation status of the related integration
17+
The installation status of the related Datadog integration.
1818
1919
:param value: Must be one of ["installed", "available", "partially_installed", "detected", "error"].
2020
:type value: str

src/datadog_api_client/v2/model/security_monitoring_content_pack_state_attributes.py

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,22 +79,29 @@ def __init__(
7979
:param cloud_siem_index_incorrect: Whether the cloud SIEM index configuration is incorrect (only applies to certain pricing models)
8080
:type cloud_siem_index_incorrect: bool
8181
82-
:param cp_activation: The activation status of a content pack
82+
:param cp_activation: The activation lifecycle state of a content pack.
8383
:type cp_activation: SecurityMonitoringContentPackActivation
8484
85-
:param filters_configured_for_logs: Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs
85+
:param filters_configured_for_logs: Whether filters (Security Filters or Index Query depending on the pricing model) are present and correctly configured to route logs into Cloud SIEM.
8686
:type filters_configured_for_logs: bool
8787
88-
:param integration_installed_status: The installation status of the related integration
88+
:param integration_installed_status: The installation status of the related Datadog integration.
8989
:type integration_installed_status: SecurityMonitoringContentPackIntegrationStatus, optional
9090
91-
:param logs_last_collected: Timestamp bucket indicating when logs were last collected
91+
:param logs_last_collected: When logs were last collected through the content pack's Cloud SIEM filter or index query.
9292
:type logs_last_collected: SecurityMonitoringContentPackTimestampBucket
9393
94-
:param logs_seen_from_any_index: Whether logs have been seen from any index
94+
:param logs_seen_from_any_index: Whether logs for this content pack have been seen in any Datadog index within the last 72 hours, regardless of whether the Cloud SIEM filter is configured.
9595
:type logs_seen_from_any_index: bool
9696
97-
:param state: The current status of a content pack
97+
:param state: The current operational status of a content pack:
98+
99+
* ``install`` : Not activated; no logs detected in the last 72 hours.
100+
* ``activate`` : Not activated; logs are flowing into a Datadog index but not yet routed through Cloud SIEM.
101+
* ``initializing`` : Activated; awaiting first log ingestion.
102+
* ``active`` : Activated; logs received within the last 24 hours.
103+
* ``warning`` : Activated; integration not installed or logs last seen 24 to 72 hours ago.
104+
* ``broken`` : Activated; no logs for over 72 hours, filter missing, or Cloud SIEM index incorrectly ordered.
98105
:type state: SecurityMonitoringContentPackStatus
99106
"""
100107
if integration_installed_status is not unset:

src/datadog_api_client/v2/model/security_monitoring_content_pack_state_meta.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def __init__(self_, cloud_siem_index_incorrect: bool, sku: SecurityMonitoringSKU
3737
:param cloud_siem_index_incorrect: Whether the cloud SIEM index configuration is incorrect at the organization level
3838
:type cloud_siem_index_incorrect: bool
3939
40-
:param sku: The SIEM pricing model (SKU) for the organization
40+
:param sku: The Cloud SIEM pricing model (SKU) for the organization.
4141
:type sku: SecurityMonitoringSKU
4242
"""
4343
super().__init__(kwargs)

src/datadog_api_client/v2/model/security_monitoring_content_pack_status.py

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

1515
class SecurityMonitoringContentPackStatus(ModelSimple):
1616
"""
17-
The current status of a content pack
17+
The current operational status of a content pack:
18+
- `install`: Not activated; no logs detected in the last 72 hours.
19+
- `activate`: Not activated; logs are flowing into a Datadog index but not yet routed through Cloud SIEM.
20+
- `initializing`: Activated; awaiting first log ingestion.
21+
- `active`: Activated; logs received within the last 24 hours.
22+
- `warning`: Activated; integration not installed or logs last seen 24 to 72 hours ago.
23+
- `broken`: Activated; no logs for over 72 hours, filter missing, or Cloud SIEM index incorrectly ordered.
1824
1925
:param value: Must be one of ["install", "activate", "initializing", "active", "warning", "broken"].
2026
:type value: str

src/datadog_api_client/v2/model/security_monitoring_content_pack_timestamp_bucket.py

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

1515
class SecurityMonitoringContentPackTimestampBucket(ModelSimple):
1616
"""
17-
Timestamp bucket indicating when logs were last collected
17+
When logs were last collected through the content pack's Cloud SIEM filter or index query.
1818
1919
:param value: Must be one of ["not_seen", "within_24_hours", "within_24_to_72_hours", "over_72h_to_30d", "over_30d"].
2020
:type value: str

src/datadog_api_client/v2/model/security_monitoring_sku.py

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

1515
class SecurityMonitoringSKU(ModelSimple):
1616
"""
17-
The SIEM pricing model (SKU) for the organization
17+
The Cloud SIEM pricing model (SKU) for the organization.
1818
1919
:param value: Must be one of ["per_gb_analyzed", "per_event_in_siem_index_2023", "add_on_2024"].
2020
:type value: str

0 commit comments

Comments
 (0)