Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
strVal: WideString;
Description: WideString;
Is_enabled: WideString;
Name: WideString;
Pattern: WideString;
Number_of_chars: WideString;
Replacement_string: WideString;
v_Type: WideString;
Id: WideString;
DataId: WideString;
DataType: WideString;
dataType: WideString;
Version: WideString;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
// 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_rule",
// "attributes": {
// "description": "<string>",
// "excluded_namespaces": [
// "<string>",
// "<string>"
// ],
// "is_enabled": "<boolean>",
// "name": "<string>",
// "namespaces": [
// "<string>",
// "<string>"
// ],
// "pattern": "<string>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "text_replacement": {
// "number_of_chars": "<long>",
// "replacement_string": "<string>",
// "type": "none"
// }
// },
// "relationships": {
// "group": {
// "data": {
// "id": "<string>",
// "type": "sensitive_data_scanner_group"
// }
// },
// "standard_pattern": {
// "data": {
// "id": "<string>",
// "type": "sensitive_data_scanner_standard_pattern"
// }
// }
// }
// },
// "meta": {
// "version": "<long>"
// }
// }
json := TChilkatJsonObject.Create(Self);
json.UpdateString('data.type','sensitive_data_scanner_rule');
json.UpdateString('data.attributes.description','<string>');
json.UpdateString('data.attributes.excluded_namespaces[0]','<string>');
json.UpdateString('data.attributes.excluded_namespaces[1]','<string>');
json.UpdateString('data.attributes.is_enabled','<boolean>');
json.UpdateString('data.attributes.name','<string>');
json.UpdateString('data.attributes.namespaces[0]','<string>');
json.UpdateString('data.attributes.namespaces[1]','<string>');
json.UpdateString('data.attributes.pattern','<string>');
json.UpdateString('data.attributes.tags[0]','<string>');
json.UpdateString('data.attributes.tags[1]','<string>');
json.UpdateString('data.attributes.text_replacement.number_of_chars','<long>');
json.UpdateString('data.attributes.text_replacement.replacement_string','<string>');
json.UpdateString('data.attributes.text_replacement.type','none');
json.UpdateString('data.relationships.group.data.id','<string>');
json.UpdateString('data.relationships.group.data.type','sensitive_data_scanner_group');
json.UpdateString('data.relationships.standard_pattern.data.id','<string>');
json.UpdateString('data.relationships.standard_pattern.data.type','sensitive_data_scanner_standard_pattern');
json.UpdateString('meta.version','<long>');
http.SetRequestHeader('Content-Type','application/json');
http.SetRequestHeader('Accept','application/json');
resp := http.PostJson3('https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/rules','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "attributes": {
// "description": "<string>",
// "excluded_namespaces": [
// "<string>",
// "<string>"
// ],
// "is_enabled": "<boolean>",
// "name": "<string>",
// "namespaces": [
// "<string>",
// "<string>"
// ],
// "pattern": "<string>",
// "tags": [
// "<string>",
// "<string>"
// ],
// "text_replacement": {
// "number_of_chars": "<long>",
// "replacement_string": "<string>",
// "type": "none"
// }
// },
// "id": "<string>",
// "relationships": {
// "group": {
// "data": {
// "id": "<string>",
// "type": "sensitive_data_scanner_group"
// }
// },
// "standard_pattern": {
// "data": {
// "id": "<string>",
// "type": "sensitive_data_scanner_standard_pattern"
// }
// }
// },
// "type": "sensitive_data_scanner_rule"
// },
// "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');
Is_enabled := jResp.StringOf('data.attributes.is_enabled');
Name := jResp.StringOf('data.attributes.name');
Pattern := jResp.StringOf('data.attributes.pattern');
Number_of_chars := jResp.StringOf('data.attributes.text_replacement.number_of_chars');
Replacement_string := jResp.StringOf('data.attributes.text_replacement.replacement_string');
v_Type := jResp.StringOf('data.attributes.text_replacement.type');
Id := jResp.StringOf('data.id');
DataId := jResp.StringOf('data.relationships.group.data.id');
DataType := jResp.StringOf('data.relationships.group.data.type');
DataId := jResp.StringOf('data.relationships.standard_pattern.data.id');
DataType := jResp.StringOf('data.relationships.standard_pattern.data.type');
dataType := jResp.StringOf('data.type');
Version := jResp.StringOf('meta.version');
i := 0;
count_i := jResp.SizeOfArray('data.attributes.excluded_namespaces');
while i < count_i do
begin
jResp.I := i;
strVal := jResp.StringOf('data.attributes.excluded_namespaces[i]');
i := i + 1;
end;
i := 0;
count_i := jResp.SizeOfArray('data.attributes.namespaces');
while i < count_i do
begin
jResp.I := i;
strVal := jResp.StringOf('data.attributes.namespaces[i]');
i := i + 1;
end;
i := 0;
count_i := jResp.SizeOfArray('data.attributes.tags');
while i < count_i do
begin
jResp.I := i;
strVal := jResp.StringOf('data.attributes.tags[i]');
i := i + 1;
end;
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "sensitive_data_scanner_rule",
"attributes": {
"description": "<string>",
"excluded_namespaces": [
"<string>",
"<string>"
],
"is_enabled": "<boolean>",
"name": "<string>",
"namespaces": [
"<string>",
"<string>"
],
"pattern": "<string>",
"tags": [
"<string>",
"<string>"
],
"text_replacement": {
"number_of_chars": "<long>",
"replacement_string": "<string>",
"type": "none"
}
},
"relationships": {
"group": {
"data": {
"id": "<string>",
"type": "sensitive_data_scanner_group"
}
},
"standard_pattern": {
"data": {
"id": "<string>",
"type": "sensitive_data_scanner_standard_pattern"
}
}
}
},
"meta": {
"version": "<long>"
}
}'
https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/rules
Postman Collection Item JSON
{
"name": "Create Scanning Rule",
"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_rule\",\n \"attributes\": {\n \"description\": \"<string>\",\n \"excluded_namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"pattern\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": \"<long>\",\n \"replacement_string\": \"<string>\",\n \"type\": \"none\"\n }\n },\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\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/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules"
]
},
"description": "Create a scanning rule in a sensitive data scanner group, ordered last.\nThe posted rule MUST include a group relationship.\nIt MUST include either a standard_pattern relationship or a regex attribute, but not both.\nIf included_attributes is empty or missing, we will scan all attributes except\nexcluded_attributes. If both are missing, we will scan the whole event."
},
"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_rule\",\n \"attributes\": {\n \"description\": \"<string>\",\n \"excluded_namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"pattern\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": \"<long>\",\n \"replacement_string\": \"<string>\",\n \"type\": \"none\"\n }\n },\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\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/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"<string>\",\n \"excluded_namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"pattern\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": \"<long>\",\n \"replacement_string\": \"<string>\",\n \"type\": \"none\"\n }\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\n }\n }\n },\n \"type\": \"sensitive_data_scanner_rule\"\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_rule\",\n \"attributes\": {\n \"description\": \"<string>\",\n \"excluded_namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"pattern\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": \"<long>\",\n \"replacement_string\": \"<string>\",\n \"type\": \"none\"\n }\n },\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\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/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules"
]
}
},
"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_rule\",\n \"attributes\": {\n \"description\": \"<string>\",\n \"excluded_namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"pattern\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": \"<long>\",\n \"replacement_string\": \"<string>\",\n \"type\": \"none\"\n }\n },\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\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/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules"
]
}
},
"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_rule\",\n \"attributes\": {\n \"description\": \"<string>\",\n \"excluded_namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"is_enabled\": \"<boolean>\",\n \"name\": \"<string>\",\n \"namespaces\": [\n \"<string>\",\n \"<string>\"\n ],\n \"pattern\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"text_replacement\": {\n \"number_of_chars\": \"<long>\",\n \"replacement_string\": \"<string>\",\n \"type\": \"none\"\n }\n },\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n },\n \"standard_pattern\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_standard_pattern\"\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/rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config",
"rules"
]
}
},
"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}"
}
]
}
