security_monitoring - Document rules bulk export (#3401)

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

examples/v2/security-monitoring/BulkExportSecurityMonitoringRules.java

@@ -0,0 +1,44 @@
+// Bulk export security monitoring rules returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SecurityMonitoringApi;
+import com.datadog.api.client.v2.model.SecurityMonitoringRuleBulkExportAttributes;
+import com.datadog.api.client.v2.model.SecurityMonitoringRuleBulkExportData;
+import com.datadog.api.client.v2.model.SecurityMonitoringRuleBulkExportDataType;
+import com.datadog.api.client.v2.model.SecurityMonitoringRuleBulkExportPayload;
+import java.io.File;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
+
+    // there is a valid "security_rule" in the system
+    String SECURITY_RULE_ID = System.getenv("SECURITY_RULE_ID");
+
+    SecurityMonitoringRuleBulkExportPayload body =
+        new SecurityMonitoringRuleBulkExportPayload()
+            .data(
+                new SecurityMonitoringRuleBulkExportData()
+                    .attributes(
+                        new SecurityMonitoringRuleBulkExportAttributes()
+                            .ruleIds(Collections.singletonList(SECURITY_RULE_ID)))
+                    .type(
+                        SecurityMonitoringRuleBulkExportDataType
+                            .SECURITY_MONITORING_RULES_BULK_EXPORT));
+
+    try {
+      File result = apiInstance.bulkExportSecurityMonitoringRules(body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println(
+          "Exception when calling SecurityMonitoringApi#bulkExportSecurityMonitoringRules");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

src/main/java/com/datadog/api/client/v2/api/SecurityMonitoringApi.java

@@ -63,6 +63,7 @@
 import com.datadog.api.client.v2.model.SecurityMonitoringCriticalAssetsResponse;
 import com.datadog.api.client.v2.model.SecurityMonitoringListRulesResponse;
 import com.datadog.api.client.v2.model.SecurityMonitoringPaginatedSuppressionsResponse;
+import com.datadog.api.client.v2.model.SecurityMonitoringRuleBulkExportPayload;
 import com.datadog.api.client.v2.model.SecurityMonitoringRuleConvertPayload;
 import com.datadog.api.client.v2.model.SecurityMonitoringRuleConvertResponse;
 import com.datadog.api.client.v2.model.SecurityMonitoringRuleCreatePayload;
@@ -98,6 +99,7 @@
 import com.datadog.api.client.v2.model.VulnerabilityType;
 import jakarta.ws.rs.client.Invocation;
 import jakarta.ws.rs.core.GenericType;
+import java.io.File;
 import java.time.OffsetDateTime;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -445,6 +447,145 @@ public CompletableFuture<ApiResponse<FindingCaseResponse>> attachJiraIssueWithHt
         new GenericType<FindingCaseResponse>() {});
   }
 
+  /**
+   * Bulk export security monitoring rules.
+   *
+   * <p>See {@link #bulkExportSecurityMonitoringRulesWithHttpInfo}.
+   *
+   * @param body (required)
+   * @return File
+   * @throws ApiException if fails to make API call
+   */
+  public File bulkExportSecurityMonitoringRules(SecurityMonitoringRuleBulkExportPayload body)
+      throws ApiException {
+    return bulkExportSecurityMonitoringRulesWithHttpInfo(body).getData();
+  }
+
+  /**
+   * Bulk export security monitoring rules.
+   *
+   * <p>See {@link #bulkExportSecurityMonitoringRulesWithHttpInfoAsync}.
+   *
+   * @param body (required)
+   * @return CompletableFuture&lt;File&gt;
+   */
+  public CompletableFuture<File> bulkExportSecurityMonitoringRulesAsync(
+      SecurityMonitoringRuleBulkExportPayload body) {
+    return bulkExportSecurityMonitoringRulesWithHttpInfoAsync(body)
+        .thenApply(
+            response -> {
+              return response.getData();
+            });
+  }
+
+  /**
+   * 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.
+   *
+   * @param body (required)
+   * @return ApiResponse&lt;File&gt;
+   * @throws ApiException if fails to make API call
+   * @http.response.details
+   *     <table border="1">
+   *    <caption>Response details</caption>
+   *       <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
+   *       <tr><td> 200 </td><td> OK </td><td>  -  </td></tr>
+   *       <tr><td> 400 </td><td> Bad Request </td><td>  -  </td></tr>
+   *       <tr><td> 403 </td><td> Not Authorized </td><td>  -  </td></tr>
+   *       <tr><td> 404 </td><td> Not Found </td><td>  -  </td></tr>
+   *       <tr><td> 429 </td><td> Too many requests </td><td>  -  </td></tr>
+   *     </table>
+   */
+  public ApiResponse<File> bulkExportSecurityMonitoringRulesWithHttpInfo(
+      SecurityMonitoringRuleBulkExportPayload body) throws ApiException {
+    Object localVarPostBody = body;
+
+    // verify the required parameter 'body' is set
+    if (body == null) {
+      throw new ApiException(
+          400,
+          "Missing the required parameter 'body' when calling bulkExportSecurityMonitoringRules");
+    }
+    // create path and map variables
+    String localVarPath = "/api/v2/security_monitoring/rules/bulk_export";
+
+    Map<String, String> localVarHeaderParams = new HashMap<String, String>();
+
+    Invocation.Builder builder =
+        apiClient.createBuilder(
+            "v2.SecurityMonitoringApi.bulkExportSecurityMonitoringRules",
+            localVarPath,
+            new ArrayList<Pair>(),
+            localVarHeaderParams,
+            new HashMap<String, String>(),
+            new String[] {"application/zip", "application/json"},
+            new String[] {"apiKeyAuth", "appKeyAuth", "AuthZ"});
+    return apiClient.invokeAPI(
+        "POST",
+        builder,
+        localVarHeaderParams,
+        new String[] {"application/json"},
+        localVarPostBody,
+        new HashMap<String, Object>(),
+        false,
+        new GenericType<File>() {});
+  }
+
+  /**
+   * Bulk export security monitoring rules.
+   *
+   * <p>See {@link #bulkExportSecurityMonitoringRulesWithHttpInfo}.
+   *
+   * @param body (required)
+   * @return CompletableFuture&lt;ApiResponse&lt;File&gt;&gt;
+   */
+  public CompletableFuture<ApiResponse<File>> bulkExportSecurityMonitoringRulesWithHttpInfoAsync(
+      SecurityMonitoringRuleBulkExportPayload body) {
+    Object localVarPostBody = body;
+
+    // verify the required parameter 'body' is set
+    if (body == null) {
+      CompletableFuture<ApiResponse<File>> result = new CompletableFuture<>();
+      result.completeExceptionally(
+          new ApiException(
+              400,
+              "Missing the required parameter 'body' when calling"
+                  + " bulkExportSecurityMonitoringRules"));
+      return result;
+    }
+    // create path and map variables
+    String localVarPath = "/api/v2/security_monitoring/rules/bulk_export";
+
+    Map<String, String> localVarHeaderParams = new HashMap<String, String>();
+
+    Invocation.Builder builder;
+    try {
+      builder =
+          apiClient.createBuilder(
+              "v2.SecurityMonitoringApi.bulkExportSecurityMonitoringRules",
+              localVarPath,
+              new ArrayList<Pair>(),
+              localVarHeaderParams,
+              new HashMap<String, String>(),
+              new String[] {"application/zip", "application/json"},
+              new String[] {"apiKeyAuth", "appKeyAuth", "AuthZ"});
+    } catch (ApiException ex) {
+      CompletableFuture<ApiResponse<File>> result = new CompletableFuture<>();
+      result.completeExceptionally(ex);
+      return result;
+    }
+    return apiClient.invokeAPIAsync(
+        "POST",
+        builder,
+        localVarHeaderParams,
+        new String[] {"application/json"},
+        localVarPostBody,
+        new HashMap<String, Object>(),
+        false,
+        new GenericType<File>() {});
+  }
+
   /**
    * Cancel a threat hunting job.
    *