Bulk convert rules to Terraform

v2 (latest)

POST https://api.ap1.datadoghq.com/api/v2/security_monitoring/rules/convert/bulkhttps://api.ap2.datadoghq.com/api/v2/security_monitoring/rules/convert/bulkhttps://api.datadoghq.eu/api/v2/security_monitoring/rules/convert/bulkhttps://api.ddog-gov.com/api/v2/security_monitoring/rules/convert/bulkhttps://api.us2.ddog-gov.com/api/v2/security_monitoring/rules/convert/bulkhttps://api.uk1.datadoghq.com/api/v2/security_monitoring/rules/convert/bulkhttps://api.datadoghq.com/api/v2/security_monitoring/rules/convert/bulkhttps://api.us3.datadoghq.com/api/v2/security_monitoring/rules/convert/bulkhttps://api.us5.datadoghq.com/api/v2/security_monitoring/rules/convert/bulk

概要

Convert a list of existing security monitoring rules to Terraform for the Datadog provider resource datadog_security_monitoring_rule. Returns a ZIP archive containing one Terraform file per rule. You can convert rules for the following types:

App and API Protection
Cloud SIEM (log detection and signal correlation)
Workload Protection

This endpoint requires the security_monitoring_rules_read permission.

OAuth apps require the security_monitoring_rules_read authorization scope to access this endpoint.

リクエスト

Body Data (required)

Expand All

フィールド

タイプ

説明

data [required]

object

Data for bulk converting security monitoring rules to Terraform.

{
  "data": {
    "attributes": {
      "ruleIds": [
        "def-000-u7q",
        "def-000-7dd"
      ]
    },
    "id": "convert_bulk",
    "type": "security_monitoring_rules_convert_bulk"
  }
}

応答

{}

Bad Request

API error response.

Expand All

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Authorized

API error response.

Expand All

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

フィールド

タイプ

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

コード例

                  ## default
# 

# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/security_monitoring/rules/convert/bulk" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "ruleIds": [
        "def-000-u7q",
        "def-000-7dd"
      ]
    },
    "id": "convert_bulk",
    "type": "security_monitoring_rules_convert_bulk"
  }
}
EOF

                

"""
Bulk convert rules to Terraform 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_convert_bulk_attributes import (
    SecurityMonitoringRuleConvertBulkAttributes,
)
from datadog_api_client.v2.model.security_monitoring_rule_convert_bulk_data import SecurityMonitoringRuleConvertBulkData
from datadog_api_client.v2.model.security_monitoring_rule_convert_bulk_data_type import (
    SecurityMonitoringRuleConvertBulkDataType,
)
from datadog_api_client.v2.model.security_monitoring_rule_convert_bulk_payload import (
    SecurityMonitoringRuleConvertBulkPayload,
)

body = SecurityMonitoringRuleConvertBulkPayload(
    data=SecurityMonitoringRuleConvertBulkData(
        attributes=SecurityMonitoringRuleConvertBulkAttributes(
            rule_ids=[
                "def-000-u7q",
                "def-000-7dd",
            ],
        ),
        id="convert_bulk",
        type=SecurityMonitoringRuleConvertBulkDataType.SECURITY_MONITORING_RULES_CONVERT_BULK,
    ),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
    api_instance = SecurityMonitoringApi(api_client)
    response = api_instance.bulk_convert_existing_security_monitoring_rules(body=body)

    print(response.read())

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"

# Bulk convert rules to Terraform returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new

body = DatadogAPIClient::V2::SecurityMonitoringRuleConvertBulkPayload.new({
  data: DatadogAPIClient::V2::SecurityMonitoringRuleConvertBulkData.new({
    attributes: DatadogAPIClient::V2::SecurityMonitoringRuleConvertBulkAttributes.new({
      rule_ids: [
        "def-000-u7q",
        "def-000-7dd",
      ],
    }),
    id: "convert_bulk",
    type: DatadogAPIClient::V2::SecurityMonitoringRuleConvertBulkDataType::SECURITY_MONITORING_RULES_CONVERT_BULK,
  }),
})
p api_instance.bulk_convert_existing_security_monitoring_rules(body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"

// Bulk convert rules to Terraform returns "OK" response

package main

import (
	"context"
	"fmt"
	"io/ioutil"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.SecurityMonitoringRuleConvertBulkPayload{
		Data: datadogV2.SecurityMonitoringRuleConvertBulkData{
			Attributes: datadogV2.SecurityMonitoringRuleConvertBulkAttributes{
				RuleIds: []string{
					"def-000-u7q",
					"def-000-7dd",
				},
			},
			Id:   datadog.PtrString("convert_bulk"),
			Type: datadogV2.SECURITYMONITORINGRULECONVERTBULKDATATYPE_SECURITY_MONITORING_RULES_CONVERT_BULK,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewSecurityMonitoringApi(apiClient)
	resp, r, err := api.BulkConvertExistingSecurityMonitoringRules(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SecurityMonitoringApi.BulkConvertExistingSecurityMonitoringRules`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := ioutil.ReadAll(resp)
	fmt.Fprintf(os.Stdout, "Response from `SecurityMonitoringApi.BulkConvertExistingSecurityMonitoringRules`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"

// Bulk convert rules to Terraform 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.SecurityMonitoringRuleConvertBulkAttributes;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleConvertBulkData;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleConvertBulkDataType;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleConvertBulkPayload;
import java.io.File;
import java.util.Arrays;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);

    SecurityMonitoringRuleConvertBulkPayload body =
        new SecurityMonitoringRuleConvertBulkPayload()
            .data(
                new SecurityMonitoringRuleConvertBulkData()
                    .attributes(
                        new SecurityMonitoringRuleConvertBulkAttributes()
                            .ruleIds(Arrays.asList("def-000-u7q", "def-000-7dd")))
                    .id("convert_bulk")
                    .type(
                        SecurityMonitoringRuleConvertBulkDataType
                            .SECURITY_MONITORING_RULES_CONVERT_BULK));

    try {
      File result = apiInstance.bulkConvertExistingSecurityMonitoringRules(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling"
              + " SecurityMonitoringApi#bulkConvertExistingSecurityMonitoringRules");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"

// Bulk convert rules to Terraform returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleConvertBulkAttributes;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleConvertBulkData;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleConvertBulkDataType;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleConvertBulkPayload;

#[tokio::main]
async fn main() {
    let body = SecurityMonitoringRuleConvertBulkPayload::new(
        SecurityMonitoringRuleConvertBulkData::new(
            SecurityMonitoringRuleConvertBulkAttributes::new(vec![
                "def-000-u7q".to_string(),
                "def-000-7dd".to_string(),
            ]),
            SecurityMonitoringRuleConvertBulkDataType::SECURITY_MONITORING_RULES_CONVERT_BULK,
        )
        .id("convert_bulk".to_string()),
    );
    let configuration = datadog::Configuration::new();
    let api = SecurityMonitoringAPI::with_config(configuration);
    let resp = api
        .bulk_convert_existing_security_monitoring_rules(body)
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run

/**
 * Bulk convert rules to Terraform returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration({
  authMethods: {
    AuthZ: {
      accessToken: process.env.DD_BEARER_TOKEN as string,
    },
  },
});
const apiInstance = new v2.SecurityMonitoringApi(configuration);

const params: v2.SecurityMonitoringApiBulkConvertExistingSecurityMonitoringRulesRequest =
  {
    body: {
      data: {
        attributes: {
          ruleIds: ["def-000-u7q", "def-000-7dd"],
        },
        id: "convert_bulk",
        type: "security_monitoring_rules_convert_bulk",
      },
    },
  };

apiInstance
  .bulkConvertExistingSecurityMonitoringRules(params)
  .then((data: client.HttpFile) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"

Bulk convert rules to Terraform

概要

リクエスト

Body Data (required)

応答

コード例

Bulk convert rules to Terraform

Bulk convert rules to Terraform

Instructions

Bulk convert rules to Terraform

Instructions

Bulk convert rules to Terraform

Instructions

Bulk convert rules to Terraform

Instructions

Bulk convert rules to Terraform

Instructions

Bulk convert rules to Terraform

Instructions

How can I help you today?