Note: This endpoint is in Preview. If you have any feedback, contact Datadog support.
POST https://api.ap1.datadoghq.com/api/v2/security_monitoring/terraform/{resource_type}/converthttps://api.ap2.datadoghq.com/api/v2/security_monitoring/terraform/{resource_type}/converthttps://api.datadoghq.eu/api/v2/security_monitoring/terraform/{resource_type}/converthttps://api.ddog-gov.com/api/v2/security_monitoring/terraform/{resource_type}/converthttps://api.us2.ddog-gov.com/api/v2/security_monitoring/terraform/{resource_type}/converthttps://api.datadoghq.com/api/v2/security_monitoring/terraform/{resource_type}/converthttps://api.us3.datadoghq.com/api/v2/security_monitoring/terraform/{resource_type}/converthttps://api.us5.datadoghq.com/api/v2/security_monitoring/terraform/{resource_type}/convert
Overview
Convert a security monitoring resource that doesn’t (yet) exist from JSON to Terraform.
The resource_type path parameter specifies the type of resource to convert
and must be one of suppressions or critical_assets.
This endpoint requires
any
of the following permissions:
security_monitoring_suppressions_readsecurity_monitoring_rules_readOAuth apps require the security_monitoring_rules_read authorization scope to access this endpoint.
Arguments
Path Parameters
The type of security monitoring resource to export.
Request
Body Data (required)
The resource JSON to convert.
Response
Code Example
// Convert 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() {
body := datadogV2.SecurityMonitoringTerraformConvertRequest{
Data: datadogV2.SecurityMonitoringTerraformConvertData{
Type: "convert_resource",
Id: "abc-123",
Attributes: datadogV2.SecurityMonitoringTerraformConvertAttributes{
ResourceJson: map[string]interface{}{
"enabled": true,
"name": "Example-Security-Monitoring",
"rule_query": "source:cloudtrail",
"suppression_query": "env:test",
},
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.ConvertSecurityMonitoringTerraformResource", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewSecurityMonitoringApi(apiClient)
resp, r, err := api.ConvertSecurityMonitoringTerraformResource(ctx, datadogV2.SECURITYMONITORINGTERRAFORMRESOURCETYPE_SUPPRESSIONS, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SecurityMonitoringApi.ConvertSecurityMonitoringTerraformResource`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `SecurityMonitoringApi.ConvertSecurityMonitoringTerraformResource`:\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"
// Convert 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.SecurityMonitoringTerraformConvertAttributes;
import com.datadog.api.client.v2.model.SecurityMonitoringTerraformConvertData;
import com.datadog.api.client.v2.model.SecurityMonitoringTerraformConvertRequest;
import com.datadog.api.client.v2.model.SecurityMonitoringTerraformExportResponse;
import com.datadog.api.client.v2.model.SecurityMonitoringTerraformResourceType;
import java.util.Map;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled(
"v2.convertSecurityMonitoringTerraformResource", true);
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
SecurityMonitoringTerraformConvertRequest body =
new SecurityMonitoringTerraformConvertRequest()
.data(
new SecurityMonitoringTerraformConvertData()
.type("convert_resource")
.id("abc-123")
.attributes(
new SecurityMonitoringTerraformConvertAttributes()
.resourceJson(
Map.ofEntries(
Map.entry("enabled", "True"),
Map.entry("name", "Example-Security-Monitoring"),
Map.entry("rule_query", "source:cloudtrail"),
Map.entry("suppression_query", "env:test")))));
try {
SecurityMonitoringTerraformExportResponse result =
apiInstance.convertSecurityMonitoringTerraformResource(
SecurityMonitoringTerraformResourceType.SUPPRESSIONS, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling"
+ " SecurityMonitoringApi#convertSecurityMonitoringTerraformResource");
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"
"""
Convert security monitoring resource to Terraform returns "OK" response
"""
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_convert_attributes import (
SecurityMonitoringTerraformConvertAttributes,
)
from datadog_api_client.v2.model.security_monitoring_terraform_convert_data import (
SecurityMonitoringTerraformConvertData,
)
from datadog_api_client.v2.model.security_monitoring_terraform_convert_request import (
SecurityMonitoringTerraformConvertRequest,
)
from datadog_api_client.v2.model.security_monitoring_terraform_resource_type import (
SecurityMonitoringTerraformResourceType,
)
body = SecurityMonitoringTerraformConvertRequest(
data=SecurityMonitoringTerraformConvertData(
type="convert_resource",
id="abc-123",
attributes=SecurityMonitoringTerraformConvertAttributes(
resource_json=dict(
[
("enabled", "True"),
("name", "Example-Security-Monitoring"),
("rule_query", "source:cloudtrail"),
("suppression_query", "env:test"),
]
),
),
),
)
configuration = Configuration()
configuration.unstable_operations["convert_security_monitoring_terraform_resource"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.convert_security_monitoring_terraform_resource(
resource_type=SecurityMonitoringTerraformResourceType.SUPPRESSIONS, body=body
)
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"
# Convert security monitoring resource to Terraform returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.convert_security_monitoring_terraform_resource".to_sym] = true
end
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
body = DatadogAPIClient::V2::SecurityMonitoringTerraformConvertRequest.new({
data: DatadogAPIClient::V2::SecurityMonitoringTerraformConvertData.new({
type: "convert_resource",
id: "abc-123",
attributes: DatadogAPIClient::V2::SecurityMonitoringTerraformConvertAttributes.new({
resource_json: {
"enabled": "True", "name": "Example-Security-Monitoring", "rule_query": "source:cloudtrail", "suppression_query": "env:test",
},
}),
}),
})
p api_instance.convert_security_monitoring_terraform_resource(SecurityMonitoringTerraformResourceType::SUPPRESSIONS, 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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Convert 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::SecurityMonitoringTerraformConvertAttributes;
use datadog_api_client::datadogV2::model::SecurityMonitoringTerraformConvertData;
use datadog_api_client::datadogV2::model::SecurityMonitoringTerraformConvertRequest;
use datadog_api_client::datadogV2::model::SecurityMonitoringTerraformResourceType;
use serde_json::Value;
use std::collections::BTreeMap;
#[tokio::main]
async fn main() {
let body = SecurityMonitoringTerraformConvertRequest::new(
SecurityMonitoringTerraformConvertData::new(
SecurityMonitoringTerraformConvertAttributes::new(BTreeMap::from([
("enabled".to_string(), Value::from("True")),
(
"name".to_string(),
Value::from("Example-Security-Monitoring"),
),
("rule_query".to_string(), Value::from("source:cloudtrail")),
("suppression_query".to_string(), Value::from("env:test")),
])),
"abc-123".to_string(),
"convert_resource".to_string(),
),
);
let mut configuration = datadog::Configuration::new();
configuration
.set_unstable_operation_enabled("v2.ConvertSecurityMonitoringTerraformResource", true);
let api = SecurityMonitoringAPI::with_config(configuration);
let resp = api
.convert_security_monitoring_terraform_resource(
SecurityMonitoringTerraformResourceType::SUPPRESSIONS,
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.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Convert security monitoring resource to Terraform returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
configuration.unstableOperations[
"v2.convertSecurityMonitoringTerraformResource"
] = true;
const apiInstance = new v2.SecurityMonitoringApi(configuration);
const params: v2.SecurityMonitoringApiConvertSecurityMonitoringTerraformResourceRequest =
{
body: {
data: {
type: "convert_resource",
id: "abc-123",
attributes: {
resourceJson: {
enabled: "True",
name: "Example-Security-Monitoring",
rule_query: "source:cloudtrail",
suppression_query: "env:test",
},
},
},
},
resourceType: "suppressions",
};
apiInstance
.convertSecurityMonitoringTerraformResource(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"
