Crear grupo de análisis
https://api.datadoghq.com/api/v2/sensitive-data-scanner/config/groupshttps://api.us3.datadoghq.com/api/v2/sensitive-data-scanner/config/groupshttps://api.us5.datadoghq.com/api/v2/sensitive-data-scanner/config/groupshttps://api.datadoghq.eu/api/v2/sensitive-data-scanner/config/groupshttps://api.ap1.datadoghq.com/api/v2/sensitive-data-scanner/config/groupshttps://api.ap2.datadoghq.com/api/v2/sensitive-data-scanner/config/groupshttps://api.uk1.datadoghq.com/api/v2/sensitive-data-scanner/config/groupshttps://api.ddog-gov.com/api/v2/sensitive-data-scanner/config/groupshttps://api.us2.ddog-gov.com/api/v2/sensitive-data-scanner/config/groupsDescripción general
Crea un grupo de análisis. La solicitud PUEDE incluir una relación de configuración. Una relación de reglas puede omitirse por completo, pero si se incluye DEBE ser nula o una matriz vacía (las reglas no pueden crearse al mismo tiempo). El nuevo grupo se ordenará en último lugar dentro de la configuración.
Solicitud
Body Data (required)
dataCrear solicitud de grupo.
attributes [required]Attributes of the Sensitive Data Scanner group.
descriptionDescription of the group.
filterFilter for the Scanning Group.
queryQuery to filter the events.
is_enabledWhether or not the group is enabled.
nameName of the group.
product_listList of products the scanning group applies.
samplingsList of sampling rates per product type.
productDatadog product onto which Sensitive Data Scanner can be activated.
logslogs, rum, events, apmrateRate at which data in product type will be scanned, as a percentage.
relationshipsRelationships of the group.
configurationA Sensitive Data Scanner configuration data.
dataA Sensitive Data Scanner configuration.
idID of the configuration.
typeSensitive Data Scanner configuration type.
sensitive_data_scanner_configurationsensitive_data_scanner_configurationrulesRules included in the group.
dataRules included in the group. The order is important.
idID of the rule.
typeSensitive Data Scanner rule type.
sensitive_data_scanner_rulesensitive_data_scanner_ruletype [required]Sensitive Data Scanner group type.
sensitive_data_scanner_groupsensitive_data_scanner_groupmetaMeta payload containing information about the API.
versionVersion of the API (optional).
{
"meta": {},
"data": {
"type": "sensitive_data_scanner_group",
"attributes": {
"name": "Example-Sensitive-Data-Scanner",
"is_enabled": false,
"product_list": [
"logs"
],
"filter": {
"query": "*"
}
},
"relationships": {
"configuration": {
"data": {
"type": "sensitive_data_scanner_configuration",
"id": "string"
}
},
"rules": {
"data": []
}
}
}
}Respuesta
OK
Create group response.
dataResponse data related to the creation of a group.
attributesAttributes of the Sensitive Data Scanner group.
descriptionDescription of the group.
filterFilter for the Scanning Group.
queryQuery to filter the events.
is_enabledWhether or not the group is enabled.
nameName of the group.
product_listList of products the scanning group applies.
samplingsList of sampling rates per product type.
productDatadog product onto which Sensitive Data Scanner can be activated.
logslogs, rum, events, apmrateRate at which data in product type will be scanned, as a percentage.
idID of the group.
relationshipsRelationships of the group.
configurationA Sensitive Data Scanner configuration data.
dataA Sensitive Data Scanner configuration.
idID of the configuration.
typeSensitive Data Scanner configuration type.
sensitive_data_scanner_configurationsensitive_data_scanner_configurationrulesRules included in the group.
dataRules included in the group. The order is important.
idID of the rule.
typeSensitive Data Scanner rule type.
sensitive_data_scanner_rulesensitive_data_scanner_ruletypeSensitive Data Scanner group type.
sensitive_data_scanner_groupsensitive_data_scanner_groupmetaMeta payload containing information about the API.
versionVersion of the API (optional).
{
"data": {
"attributes": {
"description": "string",
"filter": {
"query": "string"
},
"is_enabled": false,
"name": "string",
"product_list": [],
"samplings": [
{
"product": "string",
"rate": 100
}
]
},
"id": "string",
"relationships": {
"configuration": {
"data": {
"id": "string",
"type": "sensitive_data_scanner_configuration"
}
},
"rules": {
"data": [
{
"id": "string",
"type": "sensitive_data_scanner_rule"
}
]
}
},
"type": "sensitive_data_scanner_group"
},
"meta": {
"version": 0
}
}Bad Request
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Authentication Error
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Ejemplo de código
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/sensitive-data-scanner/config/groups" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"meta": {},
"data": {
"type": "sensitive_data_scanner_group",
"attributes": {
"name": "Example-Sensitive-Data-Scanner",
"is_enabled": false,
"product_list": [
"logs"
],
"filter": {
"query": "*"
}
},
"relationships": {
"configuration": {
"data": {
"type": "sensitive_data_scanner_configuration",
"id": "string"
}
},
"rules": {
"data": []
}
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/sensitive-data-scanner/config/groups" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"meta": {},
"data": {
"type": "sensitive_data_scanner_group",
"attributes": {
"name": "Example-Sensitive-Data-Scanner",
"is_enabled": false,
"product_list": [
"logs"
],
"filter": {
"query": "*"
}
},
"relationships": {
"configuration": {
"data": {
"type": "sensitive_data_scanner_configuration",
"id": "string"
}
},
"rules": {
"data": []
}
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/sensitive-data-scanner/config/groups" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"meta": {},
"data": {
"type": "sensitive_data_scanner_group",
"attributes": {
"name": "Example-Sensitive-Data-Scanner",
"is_enabled": false,
"product_list": [
"logs"
],
"filter": {
"query": "*"
}
},
"relationships": {
"configuration": {
"data": {
"type": "sensitive_data_scanner_configuration",
"id": "string"
}
},
"rules": {
"data": []
}
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/sensitive-data-scanner/config/groups" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"meta": {},
"data": {
"type": "sensitive_data_scanner_group",
"attributes": {
"name": "Example-Sensitive-Data-Scanner",
"is_enabled": false,
"product_list": [
"logs"
],
"filter": {
"query": "*"
}
},
"relationships": {
"configuration": {
"data": {
"type": "sensitive_data_scanner_configuration",
"id": "string"
}
},
"rules": {
"data": []
}
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/sensitive-data-scanner/config/groups" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"meta": {},
"data": {
"type": "sensitive_data_scanner_group",
"attributes": {
"name": "Example-Sensitive-Data-Scanner",
"is_enabled": false,
"product_list": [
"logs"
],
"filter": {
"query": "*"
}
},
"relationships": {
"configuration": {
"data": {
"type": "sensitive_data_scanner_configuration",
"id": "string"
}
},
"rules": {
"data": []
}
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/sensitive-data-scanner/config/groups" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"meta": {},
"data": {
"type": "sensitive_data_scanner_group",
"attributes": {
"name": "Example-Sensitive-Data-Scanner",
"is_enabled": false,
"product_list": [
"logs"
],
"filter": {
"query": "*"
}
},
"relationships": {
"configuration": {
"data": {
"type": "sensitive_data_scanner_configuration",
"id": "string"
}
},
"rules": {
"data": []
}
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/sensitive-data-scanner/config/groups" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"meta": {},
"data": {
"type": "sensitive_data_scanner_group",
"attributes": {
"name": "Example-Sensitive-Data-Scanner",
"is_enabled": false,
"product_list": [
"logs"
],
"filter": {
"query": "*"
}
},
"relationships": {
"configuration": {
"data": {
"type": "sensitive_data_scanner_configuration",
"id": "string"
}
},
"rules": {
"data": []
}
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/sensitive-data-scanner/config/groups" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"meta": {},
"data": {
"type": "sensitive_data_scanner_group",
"attributes": {
"name": "Example-Sensitive-Data-Scanner",
"is_enabled": false,
"product_list": [
"logs"
],
"filter": {
"query": "*"
}
},
"relationships": {
"configuration": {
"data": {
"type": "sensitive_data_scanner_configuration",
"id": "string"
}
},
"rules": {
"data": []
}
}
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/sensitive-data-scanner/config/groups" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"meta": {},
"data": {
"type": "sensitive_data_scanner_group",
"attributes": {
"name": "Example-Sensitive-Data-Scanner",
"is_enabled": false,
"product_list": [
"logs"
],
"filter": {
"query": "*"
}
},
"relationships": {
"configuration": {
"data": {
"type": "sensitive_data_scanner_configuration",
"id": "string"
}
},
"rules": {
"data": []
}
}
}
}
EOF// Create Scanning Group 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() {
// a valid "configuration" in the system
ConfigurationDataID := os.Getenv("CONFIGURATION_DATA_ID")
body := datadogV2.SensitiveDataScannerGroupCreateRequest{
Meta: &datadogV2.SensitiveDataScannerMetaVersionOnly{},
Data: &datadogV2.SensitiveDataScannerGroupCreate{
Type: datadogV2.SENSITIVEDATASCANNERGROUPTYPE_SENSITIVE_DATA_SCANNER_GROUP,
Attributes: datadogV2.SensitiveDataScannerGroupAttributes{
Name: datadog.PtrString("Example-Sensitive-Data-Scanner"),
IsEnabled: datadog.PtrBool(false),
ProductList: []datadogV2.SensitiveDataScannerProduct{
datadogV2.SENSITIVEDATASCANNERPRODUCT_LOGS,
},
Filter: &datadogV2.SensitiveDataScannerFilter{
Query: datadog.PtrString("*"),
},
},
Relationships: &datadogV2.SensitiveDataScannerGroupRelationships{
Configuration: &datadogV2.SensitiveDataScannerConfigurationData{
Data: &datadogV2.SensitiveDataScannerConfiguration{
Type: datadogV2.SENSITIVEDATASCANNERCONFIGURATIONTYPE_SENSITIVE_DATA_SCANNER_CONFIGURATIONS.Ptr(),
Id: datadog.PtrString(ConfigurationDataID),
},
},
Rules: &datadogV2.SensitiveDataScannerRuleData{
Data: []datadogV2.SensitiveDataScannerRule{},
},
},
},
}
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.NewSensitiveDataScannerApi(apiClient)
resp, r, err := api.CreateScanningGroup(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SensitiveDataScannerApi.CreateScanningGroup`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `SensitiveDataScannerApi.CreateScanningGroup`:\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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"// Create Scanning Group returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SensitiveDataScannerApi;
import com.datadog.api.client.v2.model.SensitiveDataScannerConfiguration;
import com.datadog.api.client.v2.model.SensitiveDataScannerConfigurationData;
import com.datadog.api.client.v2.model.SensitiveDataScannerConfigurationType;
import com.datadog.api.client.v2.model.SensitiveDataScannerCreateGroupResponse;
import com.datadog.api.client.v2.model.SensitiveDataScannerFilter;
import com.datadog.api.client.v2.model.SensitiveDataScannerGroupAttributes;
import com.datadog.api.client.v2.model.SensitiveDataScannerGroupCreate;
import com.datadog.api.client.v2.model.SensitiveDataScannerGroupCreateRequest;
import com.datadog.api.client.v2.model.SensitiveDataScannerGroupRelationships;
import com.datadog.api.client.v2.model.SensitiveDataScannerGroupType;
import com.datadog.api.client.v2.model.SensitiveDataScannerMetaVersionOnly;
import com.datadog.api.client.v2.model.SensitiveDataScannerProduct;
import com.datadog.api.client.v2.model.SensitiveDataScannerRuleData;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
SensitiveDataScannerApi apiInstance = new SensitiveDataScannerApi(defaultClient);
// a valid "configuration" in the system
String CONFIGURATION_DATA_ID = System.getenv("CONFIGURATION_DATA_ID");
SensitiveDataScannerGroupCreateRequest body =
new SensitiveDataScannerGroupCreateRequest()
.meta(new SensitiveDataScannerMetaVersionOnly())
.data(
new SensitiveDataScannerGroupCreate()
.type(SensitiveDataScannerGroupType.SENSITIVE_DATA_SCANNER_GROUP)
.attributes(
new SensitiveDataScannerGroupAttributes()
.name("Example-Sensitive-Data-Scanner")
.isEnabled(false)
.productList(
Collections.singletonList(SensitiveDataScannerProduct.LOGS))
.filter(new SensitiveDataScannerFilter().query("*")))
.relationships(
new SensitiveDataScannerGroupRelationships()
.configuration(
new SensitiveDataScannerConfigurationData()
.data(
new SensitiveDataScannerConfiguration()
.type(
SensitiveDataScannerConfigurationType
.SENSITIVE_DATA_SCANNER_CONFIGURATIONS)
.id(CONFIGURATION_DATA_ID)))
.rules(new SensitiveDataScannerRuleData())));
try {
SensitiveDataScannerCreateGroupResponse result = apiInstance.createScanningGroup(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SensitiveDataScannerApi#createScanningGroup");
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java""""
Create Scanning Group returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.sensitive_data_scanner_api import SensitiveDataScannerApi
from datadog_api_client.v2.model.sensitive_data_scanner_configuration import SensitiveDataScannerConfiguration
from datadog_api_client.v2.model.sensitive_data_scanner_configuration_data import SensitiveDataScannerConfigurationData
from datadog_api_client.v2.model.sensitive_data_scanner_configuration_type import SensitiveDataScannerConfigurationType
from datadog_api_client.v2.model.sensitive_data_scanner_filter import SensitiveDataScannerFilter
from datadog_api_client.v2.model.sensitive_data_scanner_group_attributes import SensitiveDataScannerGroupAttributes
from datadog_api_client.v2.model.sensitive_data_scanner_group_create import SensitiveDataScannerGroupCreate
from datadog_api_client.v2.model.sensitive_data_scanner_group_create_request import (
SensitiveDataScannerGroupCreateRequest,
)
from datadog_api_client.v2.model.sensitive_data_scanner_group_relationships import (
SensitiveDataScannerGroupRelationships,
)
from datadog_api_client.v2.model.sensitive_data_scanner_group_type import SensitiveDataScannerGroupType
from datadog_api_client.v2.model.sensitive_data_scanner_meta_version_only import SensitiveDataScannerMetaVersionOnly
from datadog_api_client.v2.model.sensitive_data_scanner_product import SensitiveDataScannerProduct
from datadog_api_client.v2.model.sensitive_data_scanner_rule_data import SensitiveDataScannerRuleData
# a valid "configuration" in the system
CONFIGURATION_DATA_ID = environ["CONFIGURATION_DATA_ID"]
body = SensitiveDataScannerGroupCreateRequest(
meta=SensitiveDataScannerMetaVersionOnly(),
data=SensitiveDataScannerGroupCreate(
type=SensitiveDataScannerGroupType.SENSITIVE_DATA_SCANNER_GROUP,
attributes=SensitiveDataScannerGroupAttributes(
name="Example-Sensitive-Data-Scanner",
is_enabled=False,
product_list=[
SensitiveDataScannerProduct.LOGS,
],
filter=SensitiveDataScannerFilter(
query="*",
),
),
relationships=SensitiveDataScannerGroupRelationships(
configuration=SensitiveDataScannerConfigurationData(
data=SensitiveDataScannerConfiguration(
type=SensitiveDataScannerConfigurationType.SENSITIVE_DATA_SCANNER_CONFIGURATIONS,
id=CONFIGURATION_DATA_ID,
),
),
rules=SensitiveDataScannerRuleData(
data=[],
),
),
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = SensitiveDataScannerApi(api_client)
response = api_instance.create_scanning_group(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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"# Create Scanning Group returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::SensitiveDataScannerAPI.new
# a valid "configuration" in the system
CONFIGURATION_DATA_ID = ENV["CONFIGURATION_DATA_ID"]
body = DatadogAPIClient::V2::SensitiveDataScannerGroupCreateRequest.new({
meta: DatadogAPIClient::V2::SensitiveDataScannerMetaVersionOnly.new({}),
data: DatadogAPIClient::V2::SensitiveDataScannerGroupCreate.new({
type: DatadogAPIClient::V2::SensitiveDataScannerGroupType::SENSITIVE_DATA_SCANNER_GROUP,
attributes: DatadogAPIClient::V2::SensitiveDataScannerGroupAttributes.new({
name: "Example-Sensitive-Data-Scanner",
is_enabled: false,
product_list: [
DatadogAPIClient::V2::SensitiveDataScannerProduct::LOGS,
],
filter: DatadogAPIClient::V2::SensitiveDataScannerFilter.new({
query: "*",
}),
}),
relationships: DatadogAPIClient::V2::SensitiveDataScannerGroupRelationships.new({
configuration: DatadogAPIClient::V2::SensitiveDataScannerConfigurationData.new({
data: DatadogAPIClient::V2::SensitiveDataScannerConfiguration.new({
type: DatadogAPIClient::V2::SensitiveDataScannerConfigurationType::SENSITIVE_DATA_SCANNER_CONFIGURATIONS,
id: CONFIGURATION_DATA_ID,
}),
}),
rules: DatadogAPIClient::V2::SensitiveDataScannerRuleData.new({
data: [],
}),
}),
}),
})
p api_instance.create_scanning_group(body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"// Create Scanning Group returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_sensitive_data_scanner::SensitiveDataScannerAPI;
use datadog_api_client::datadogV2::model::SensitiveDataScannerConfiguration;
use datadog_api_client::datadogV2::model::SensitiveDataScannerConfigurationData;
use datadog_api_client::datadogV2::model::SensitiveDataScannerConfigurationType;
use datadog_api_client::datadogV2::model::SensitiveDataScannerFilter;
use datadog_api_client::datadogV2::model::SensitiveDataScannerGroupAttributes;
use datadog_api_client::datadogV2::model::SensitiveDataScannerGroupCreate;
use datadog_api_client::datadogV2::model::SensitiveDataScannerGroupCreateRequest;
use datadog_api_client::datadogV2::model::SensitiveDataScannerGroupRelationships;
use datadog_api_client::datadogV2::model::SensitiveDataScannerGroupType;
use datadog_api_client::datadogV2::model::SensitiveDataScannerMetaVersionOnly;
use datadog_api_client::datadogV2::model::SensitiveDataScannerProduct;
use datadog_api_client::datadogV2::model::SensitiveDataScannerRuleData;
#[tokio::main]
async fn main() {
// a valid "configuration" in the system
let configuration_data_id = std::env::var("CONFIGURATION_DATA_ID").unwrap();
let body =
SensitiveDataScannerGroupCreateRequest::new()
.data(
SensitiveDataScannerGroupCreate::new(
SensitiveDataScannerGroupAttributes::new()
.filter(SensitiveDataScannerFilter::new().query("*".to_string()))
.is_enabled(false)
.name("Example-Sensitive-Data-Scanner".to_string())
.product_list(vec![SensitiveDataScannerProduct::LOGS]),
SensitiveDataScannerGroupType::SENSITIVE_DATA_SCANNER_GROUP,
).relationships(
SensitiveDataScannerGroupRelationships::new()
.configuration(
SensitiveDataScannerConfigurationData
::new().data(
SensitiveDataScannerConfiguration::new()
.id(configuration_data_id.clone())
.type_(
SensitiveDataScannerConfigurationType::SENSITIVE_DATA_SCANNER_CONFIGURATIONS,
),
),
)
.rules(SensitiveDataScannerRuleData::new().data(vec![])),
),
)
.meta(SensitiveDataScannerMetaVersionOnly::new());
let configuration = datadog::Configuration::new();
let api = SensitiveDataScannerAPI::with_config(configuration);
let resp = api.create_scanning_group(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.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run/**
* Create Scanning Group 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.SensitiveDataScannerApi(configuration);
// a valid "configuration" in the system
const CONFIGURATION_DATA_ID = process.env.CONFIGURATION_DATA_ID as string;
const params: v2.SensitiveDataScannerApiCreateScanningGroupRequest = {
body: {
meta: {},
data: {
type: "sensitive_data_scanner_group",
attributes: {
name: "Example-Sensitive-Data-Scanner",
isEnabled: false,
productList: ["logs"],
filter: {
query: "*",
},
},
relationships: {
configuration: {
data: {
type: "sensitive_data_scanner_configuration",
id: CONFIGURATION_DATA_ID,
},
},
rules: {
data: [],
},
},
},
},
};
apiInstance
.createScanningGroup(params)
.then((data: v2.SensitiveDataScannerCreateGroupResponse) => {
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.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"