Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "data": {
# "type": "sensitive_data_scanner_group",
# "attributes": {
# "description": "<string>",
# "filter": {
# "query": "<string>"
# },
# "is_enabled": "<boolean>",
# "name": "<string>",
# "product_list": [
# "logs",
# "logs"
# ]
# },
# "relationships": {
# "configuration": {
# "data": {
# "id": "<string>",
# "type": "sensitive_data_scanner_configuration"
# }
# },
# "rules": {
# "data": [
# {
# "id": "<string>",
# "type": "sensitive_data_scanner_rule"
# },
# {
# "id": "<string>",
# "type": "sensitive_data_scanner_rule"
# }
# ]
# }
# }
# },
# "meta": {
# "version": "<long>"
# }
# }
$json = chilkat::CkJsonObject->new();
$json->UpdateString("data.type","sensitive_data_scanner_group");
$json->UpdateString("data.attributes.description","<string>");
$json->UpdateString("data.attributes.filter.query","<string>");
$json->UpdateString("data.attributes.is_enabled","<boolean>");
$json->UpdateString("data.attributes.name","<string>");
$json->UpdateString("data.attributes.product_list[0]","logs");
$json->UpdateString("data.attributes.product_list[1]","logs");
$json->UpdateString("data.relationships.configuration.data.id","<string>");
$json->UpdateString("data.relationships.configuration.data.type","sensitive_data_scanner_configuration");
$json->UpdateString("data.relationships.rules.data[0].id","<string>");
$json->UpdateString("data.relationships.rules.data[0].type","sensitive_data_scanner_rule");
$json->UpdateString("data.relationships.rules.data[1].id","<string>");
$json->UpdateString("data.relationships.rules.data[1].type","sensitive_data_scanner_rule");
$json->UpdateString("meta.version","<long>");
$http->SetRequestHeader("Content-Type","application/json");
$http->SetRequestHeader("Accept","application/json");
# resp is a HttpResponse
$resp = $http->PostJson3("https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/groups","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": {
# "attributes": {
# "description": "<string>",
# "filter": {
# "query": "<string>"
# },
# "is_enabled": "<boolean>",
# "name": "<string>",
# "product_list": [
# "logs",
# "logs"
# ]
# },
# "id": "<string>",
# "relationships": {
# "configuration": {
# "data": {
# "id": "<string>",
# "type": "sensitive_data_scanner_configuration"
# }
# },
# "rules": {
# "data": [
# {
# "id": "<string>",
# "type": "sensitive_data_scanner_rule"
# },
# {
# "id": "<string>",
# "type": "sensitive_data_scanner_rule"
# }
# ]
# }
# },
# "type": "sensitive_data_scanner_group"
# },
# "meta": {
# "version": "<long>"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Description = $jResp->stringOf("data.attributes.description");
$Query = $jResp->stringOf("data.attributes.filter.query");
$Is_enabled = $jResp->stringOf("data.attributes.is_enabled");
$Name = $jResp->stringOf("data.attributes.name");
$Id = $jResp->stringOf("data.id");
$DataId = $jResp->stringOf("data.relationships.configuration.data.id");
$v_Type = $jResp->stringOf("data.relationships.configuration.data.type");
$dataType = $jResp->stringOf("data.type");
$Version = $jResp->stringOf("meta.version");
$i = 0;
$count_i = $jResp->SizeOfArray("data.attributes.product_list");
while ($i < $count_i) {
$jResp->put_I($i);
$strVal = $jResp->stringOf("data.attributes.product_list[i]");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("data.relationships.rules.data");
while ($i < $count_i) {
$jResp->put_I($i);
$id = $jResp->stringOf("data.relationships.rules.data[i].id");
$v_type = $jResp->stringOf("data.relationships.rules.data[i].type");
$i = $i + 1;
}
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "sensitive_data_scanner_group",
"attributes": {
"description": "<string>",
"filter": {
"query": "<string>"
},
"is_enabled": "<boolean>",
"name": "<string>",
"product_list": [
"logs",
"logs"
]
},
"relationships": {
"configuration": {
"data": {
"id": "<string>",
"type": "sensitive_data_scanner_configuration"
}
},
"rules": {
"data": [
{
"id": "<string>",
"type": "sensitive_data_scanner_rule"
},
{
"id": "<string>",
"type": "sensitive_data_scanner_rule"
}
]
}
}
},
"meta": {
"version": "<long>"
}
}'
https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/groups
Postman Collection Item JSON
{
"name": "Create Scanning Group",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_group\",\n \"attributes\": {\n \"description\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n }\n },\n \"meta\": {\n \"version\": \"<long>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups"
]
},
"description": "Create a scanning group.\nThe request MAY include a configuration relationship.\nA rules relationship can be omitted entirely, but if it is included it MUST be\nnull or an empty array (rules cannot be created at the same time).\nThe new group will be ordered last within the configuration."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_group\",\n \"attributes\": {\n \"description\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n }\n },\n \"meta\": {\n \"version\": \"<long>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_group\"\n },\n \"meta\": {\n \"version\": \"<long>\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_group\",\n \"attributes\": {\n \"description\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n }\n },\n \"meta\": {\n \"version\": \"<long>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Authentication Error",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_group\",\n \"attributes\": {\n \"description\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n }\n },\n \"meta\": {\n \"version\": \"<long>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_group\",\n \"attributes\": {\n \"description\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"product_list\": [\n \"logs\",\n \"logs\"\n ]\n },\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_configuration\"\n }\n },\n \"rules\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_rule\"\n }\n ]\n }\n }\n },\n \"meta\": {\n \"version\": \"<long>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"groups"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
