Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED US2-FED

Export security monitoring resource to Terraform

Note: This endpoint is in Preview. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/security_monitoring/terraform/{resource_type}/{resource_id}https://api.ap2.datadoghq.com/api/v2/security_monitoring/terraform/{resource_type}/{resource_id}https://api.datadoghq.eu/api/v2/security_monitoring/terraform/{resource_type}/{resource_id}https://api.ddog-gov.com/api/v2/security_monitoring/terraform/{resource_type}/{resource_id}https://api.us2.ddog-gov.com/api/v2/security_monitoring/terraform/{resource_type}/{resource_id}https://api.datadoghq.com/api/v2/security_monitoring/terraform/{resource_type}/{resource_id}https://api.us3.datadoghq.com/api/v2/security_monitoring/terraform/{resource_type}/{resource_id}https://api.us5.datadoghq.com/api/v2/security_monitoring/terraform/{resource_type}/{resource_id}

Overview

Export a security monitoring resource to a Terraform configuration. The resource_type path parameter specifies the type of resource to export and must be one of suppressions or critical_assets. This endpoint requires any of the following permissions:

  • security_monitoring_suppressions_read
  • security_monitoring_rules_read

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

    Arguments

    Path Parameters

    Name

    Type

    Description

    resource_type [required]

    string

    The type of security monitoring resource to export.

    resource_id [required]

    string

    The ID of the security monitoring resource to export.

    Response

    OK

    Response containing the Terraform configuration for a security monitoring resource.

    Expand All

    Field

    Type

    Description

    data

    object

    The Terraform export data object.

    attributes [required]

    object

    Attributes of the Terraform export response.

    output

    string

    The Terraform configuration for the resource.

    resource_id [required]

    string

    The ID of the exported resource.

    type_name [required]

    string

    The Terraform resource type name.

    id [required]

    string

    The resource identifier composed of the Terraform type name and the resource ID separated by |.

    type [required]

    string

    The JSON:API type. Always format_resource.

    {
  "data": {
    "attributes": {
      "output": "string",
      "resource_id": "abc-123",
      "type_name": "datadog_security_monitoring_suppression"
    },
    "id": "datadog_security_monitoring_suppression|abc-123",
    "type": "format_resource"
  }
}

    Not Authorized

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

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

    Not Found

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

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

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

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

    Code Example

                      # Path parameters
    export resource_type="CHANGE_ME"
    export resource_id="CHANGE_ME"
    # Curl command
    curl -X GET "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.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/security_monitoring/terraform/${resource_type}/${resource_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
    
                
    """
Export security monitoring resource 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_terraform_resource_type import (
    SecurityMonitoringTerraformResourceType,
)

# there is a valid "suppression" in the system
SUPPRESSION_DATA_ID = environ["SUPPRESSION_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["export_security_monitoring_terraform_resource"] = True
with ApiClient(configuration) as api_client:
    api_instance = SecurityMonitoringApi(api_client)
    response = api_instance.export_security_monitoring_terraform_resource(
        resource_type=SecurityMonitoringTerraformResourceType.SUPPRESSIONS,
        resource_id=SUPPRESSION_DATA_ID,
    )

    print(response)

    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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
    # Export security monitoring resource to Terraform returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.export_security_monitoring_terraform_resource".to_sym] = true
end
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new

# there is a valid "suppression" in the system
SUPPRESSION_DATA_ID = ENV["SUPPRESSION_DATA_ID"]
p api_instance.export_security_monitoring_terraform_resource(SecurityMonitoringTerraformResourceType::SUPPRESSIONS, SUPPRESSION_DATA_ID)

    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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
    // Export security monitoring resource to Terraform returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

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

func main() {
	// there is a valid "suppression" in the system
	SuppressionDataID := os.Getenv("SUPPRESSION_DATA_ID")

	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.ExportSecurityMonitoringTerraformResource", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewSecurityMonitoringApi(apiClient)
	resp, r, err := api.ExportSecurityMonitoringTerraformResource(ctx, datadogV2.SECURITYMONITORINGTERRAFORMRESOURCETYPE_SUPPRESSIONS, SuppressionDataID)

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

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `SecurityMonitoringApi.ExportSecurityMonitoringTerraformResource`:\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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
    // Export security monitoring resource 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.SecurityMonitoringTerraformExportResponse;
import com.datadog.api.client.v2.model.SecurityMonitoringTerraformResourceType;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.exportSecurityMonitoringTerraformResource", true);
    SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);

    // there is a valid "suppression" in the system
    String SUPPRESSION_DATA_ID = System.getenv("SUPPRESSION_DATA_ID");

    try {
      SecurityMonitoringTerraformExportResponse result =
          apiInstance.exportSecurityMonitoringTerraformResource(
              SecurityMonitoringTerraformResourceType.SUPPRESSIONS, SUPPRESSION_DATA_ID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling SecurityMonitoringApi#exportSecurityMonitoringTerraformResource");
      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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
    // Export security monitoring resource 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::SecurityMonitoringTerraformResourceType;

#[tokio::main]
async fn main() {
    // there is a valid "suppression" in the system
    let suppression_data_id = std::env::var("SUPPRESSION_DATA_ID").unwrap();
    let mut configuration = datadog::Configuration::new();
    configuration
        .set_unstable_operation_enabled("v2.ExportSecurityMonitoringTerraformResource", true);
    let api = SecurityMonitoringAPI::with_config(configuration);
    let resp = api
        .export_security_monitoring_terraform_resource(
            SecurityMonitoringTerraformResourceType::SUPPRESSIONS,
            suppression_data_id.clone(),
        )
        .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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
    /**
 * Export security monitoring resource to Terraform returns "OK" response
 */

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

const configuration = client.createConfiguration();
configuration.unstableOperations[
  "v2.exportSecurityMonitoringTerraformResource"
] = true;
const apiInstance = new v2.SecurityMonitoringApi(configuration);

// there is a valid "suppression" in the system
const SUPPRESSION_DATA_ID = process.env.SUPPRESSION_DATA_ID as string;

const params: v2.SecurityMonitoringApiExportSecurityMonitoringTerraformResourceRequest =
  {
    resourceType: "suppressions",
    resourceId: SUPPRESSION_DATA_ID,
  };

apiInstance
  .exportSecurityMonitoringTerraformResource(params)
  .then((data: v2.SecurityMonitoringTerraformExportResponse) => {
    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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"