security_monitoring - Document rules bulk export (#3097)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -49985,6 +49985,55 @@ components:
       - TWO_DAYS
       - ONE_WEEK
       - TWO_WEEKS
+    SecurityMonitoringRuleBulkExportAttributes:
+      description: Attributes for bulk exporting security monitoring rules.
+      properties:
+        ruleIds:
+          description: 'List of rule IDs to export. Each rule will be included in
+            the resulting ZIP file
+
+            as a separate JSON file.'
+          example:
+          - def-000-u7q
+          - def-000-7dd
+          items:
+            type: string
+          minItems: 1
+          type: array
+      required:
+      - ruleIds
+      type: object
+    SecurityMonitoringRuleBulkExportData:
+      description: Data for bulk exporting security monitoring rules.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportAttributes'
+        id:
+          description: Request ID.
+          example: bulk_export
+          type: string
+        type:
+          $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportDataType'
+      required:
+      - attributes
+      - type
+      type: object
+    SecurityMonitoringRuleBulkExportDataType:
+      description: The type of the resource.
+      enum:
+      - security_monitoring_rules_bulk_export
+      example: security_monitoring_rules_bulk_export
+      type: string
+      x-enum-varnames:
+      - SECURITY_MONITORING_RULES_BULK_EXPORT
+    SecurityMonitoringRuleBulkExportPayload:
+      description: Payload for bulk exporting security monitoring rules.
+      properties:
+        data:
+          $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportData'
+      required:
+      - data
+      type: object
     SecurityMonitoringRuleCase:
       description: Case when signal is generated.
       properties:
@@ -87257,6 +87306,51 @@ paths:
         operator: OR
         permissions:
         - security_monitoring_rules_write
+  /api/v2/security_monitoring/rules/bulk_export:
+    post:
+      description: 'Export a list of security monitoring rules as a ZIP file containing
+        JSON rule definitions.
+
+        The endpoint accepts a list of rule IDs and returns a ZIP archive where each
+        rule is
+
+        saved as a separate JSON file named after the rule.'
+      operationId: BulkExportSecurityMonitoringRules
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportPayload'
+        required: true
+      responses:
+        '200':
+          content:
+            application/zip:
+              schema:
+                format: binary
+                type: string
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - security_monitoring_rules_read
+      summary: Bulk export security monitoring rules
+      tags:
+      - Security Monitoring
+      x-codegen-request-body-name: body
+      x-permission:
+        operator: OR
+        permissions:
+        - security_monitoring_rules_read
   /api/v2/security_monitoring/rules/convert:
     post:
       description: 'Convert a rule that doesn''t (yet) exist from JSON to Terraform

docs/datadog_api_client.v2.model.rst

@@ -22026,6 +22026,34 @@ datadog\_api\_client.v2.model.security\_monitoring\_rule\_anomaly\_detection\_op
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.security\_monitoring\_rule\_bulk\_export\_attributes module
+-----------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_rule_bulk_export_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.security\_monitoring\_rule\_bulk\_export\_data module
+-----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_rule_bulk_export_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.security\_monitoring\_rule\_bulk\_export\_data\_type module
+-----------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_rule_bulk_export_data_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.security\_monitoring\_rule\_bulk\_export\_payload module
+--------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_rule_bulk_export_payload
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.security\_monitoring\_rule\_case module
 ---------------------------------------------------------------------
 

examples/v2/security-monitoring/BulkExportSecurityMonitoringRules.py

@@ -0,0 +1,38 @@
+"""
+Bulk export security monitoring rules returns "OK" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+from datadog_api_client.v2.model.security_monitoring_rule_bulk_export_attributes import (
+    SecurityMonitoringRuleBulkExportAttributes,
+)
+from datadog_api_client.v2.model.security_monitoring_rule_bulk_export_data import SecurityMonitoringRuleBulkExportData
+from datadog_api_client.v2.model.security_monitoring_rule_bulk_export_data_type import (
+    SecurityMonitoringRuleBulkExportDataType,
+)
+from datadog_api_client.v2.model.security_monitoring_rule_bulk_export_payload import (
+    SecurityMonitoringRuleBulkExportPayload,
+)
+
+# there is a valid "security_rule" in the system
+SECURITY_RULE_ID = environ["SECURITY_RULE_ID"]
+
+body = SecurityMonitoringRuleBulkExportPayload(
+    data=SecurityMonitoringRuleBulkExportData(
+        attributes=SecurityMonitoringRuleBulkExportAttributes(
+            rule_ids=[
+                SECURITY_RULE_ID,
+            ],
+        ),
+        type=SecurityMonitoringRuleBulkExportDataType.SECURITY_MONITORING_RULES_BULK_EXPORT,
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.bulk_export_security_monitoring_rules(body=body)
+
+    print(response.read())

src/datadog_api_client/v2/api/security_monitoring_api.py

@@ -12,6 +12,7 @@
     datetime,
     set_attribute_from_path,
     get_attribute_from_path,
+    file_type,
     UnsetType,
     unset,
 )
@@ -103,6 +104,9 @@
 from datadog_api_client.v2.model.get_suppression_version_history_response import GetSuppressionVersionHistoryResponse
 from datadog_api_client.v2.model.security_monitoring_list_rules_response import SecurityMonitoringListRulesResponse
 from datadog_api_client.v2.model.security_monitoring_rule_response import SecurityMonitoringRuleResponse
+from datadog_api_client.v2.model.security_monitoring_rule_bulk_export_payload import (
+    SecurityMonitoringRuleBulkExportPayload,
+)
 from datadog_api_client.v2.model.security_monitoring_rule_convert_response import SecurityMonitoringRuleConvertResponse
 from datadog_api_client.v2.model.security_monitoring_rule_convert_payload import SecurityMonitoringRuleConvertPayload
 from datadog_api_client.v2.model.security_monitoring_standard_rule_payload import SecurityMonitoringStandardRulePayload
@@ -196,6 +200,26 @@ def __init__(self, api_client=None):
             api_client=api_client,
         )
 
+        self._bulk_export_security_monitoring_rules_endpoint = _Endpoint(
+            settings={
+                "response_type": (file_type,),
+                "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
+                "endpoint_path": "/api/v2/security_monitoring/rules/bulk_export",
+                "operation_id": "bulk_export_security_monitoring_rules",
+                "http_method": "POST",
+                "version": "v2",
+            },
+            params_map={
+                "body": {
+                    "required": True,
+                    "openapi_types": (SecurityMonitoringRuleBulkExportPayload,),
+                    "location": "body",
+                },
+            },
+            headers_map={"accept": ["application/zip", "application/json"], "content_type": ["application/json"]},
+            api_client=api_client,
+        )
+
         self._cancel_threat_hunting_job_endpoint = _Endpoint(
             settings={
                 "response_type": None,
@@ -2622,6 +2646,24 @@ def attach_jira_issue(
 
         return self._attach_jira_issue_endpoint.call_with_http_info(**kwargs)
 
+    def bulk_export_security_monitoring_rules(
+        self,
+        body: SecurityMonitoringRuleBulkExportPayload,
+    ) -> file_type:
+        """Bulk export security monitoring rules.
+
+        Export a list of security monitoring rules as a ZIP file containing JSON rule definitions.
+        The endpoint accepts a list of rule IDs and returns a ZIP archive where each rule is
+        saved as a separate JSON file named after the rule.
+
+        :type body: SecurityMonitoringRuleBulkExportPayload
+        :rtype: file_type
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["body"] = body
+
+        return self._bulk_export_security_monitoring_rules_endpoint.call_with_http_info(**kwargs)
+
     def cancel_threat_hunting_job(
         self,
         job_id: str,

src/datadog_api_client/v2/model/security_monitoring_rule_bulk_export_attributes.py

@@ -0,0 +1,41 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import List
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+)
+
+
+class SecurityMonitoringRuleBulkExportAttributes(ModelNormal):
+    validations = {
+        "rule_ids": {
+            "min_items": 1,
+        },
+    }
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "rule_ids": ([str],),
+        }
+
+    attribute_map = {
+        "rule_ids": "ruleIds",
+    }
+
+    def __init__(self_, rule_ids: List[str], **kwargs):
+        """
+        Attributes for bulk exporting security monitoring rules.
+
+        :param rule_ids: List of rule IDs to export. Each rule will be included in the resulting ZIP file
+            as a separate JSON file.
+        :type rule_ids: [str]
+        """
+        super().__init__(kwargs)
+
+        self_.rule_ids = rule_ids

src/datadog_api_client/v2/model/security_monitoring_rule_bulk_export_data.py

@@ -0,0 +1,71 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.security_monitoring_rule_bulk_export_attributes import (
+        SecurityMonitoringRuleBulkExportAttributes,
+    )
+    from datadog_api_client.v2.model.security_monitoring_rule_bulk_export_data_type import (
+        SecurityMonitoringRuleBulkExportDataType,
+    )
+
+
+class SecurityMonitoringRuleBulkExportData(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.security_monitoring_rule_bulk_export_attributes import (
+            SecurityMonitoringRuleBulkExportAttributes,
+        )
+        from datadog_api_client.v2.model.security_monitoring_rule_bulk_export_data_type import (
+            SecurityMonitoringRuleBulkExportDataType,
+        )
+
+        return {
+            "attributes": (SecurityMonitoringRuleBulkExportAttributes,),
+            "id": (str,),
+            "type": (SecurityMonitoringRuleBulkExportDataType,),
+        }
+
+    attribute_map = {
+        "attributes": "attributes",
+        "id": "id",
+        "type": "type",
+    }
+
+    def __init__(
+        self_,
+        attributes: SecurityMonitoringRuleBulkExportAttributes,
+        type: SecurityMonitoringRuleBulkExportDataType,
+        id: Union[str, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        Data for bulk exporting security monitoring rules.
+
+        :param attributes: Attributes for bulk exporting security monitoring rules.
+        :type attributes: SecurityMonitoringRuleBulkExportAttributes
+
+        :param id: Request ID.
+        :type id: str, optional
+
+        :param type: The type of the resource.
+        :type type: SecurityMonitoringRuleBulkExportDataType
+        """
+        if id is not unset:
+            kwargs["id"] = id
+        super().__init__(kwargs)
+
+        self_.attributes = attributes
+        self_.type = type