Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_StrVal
string ls_Id
string ls_V_type
string ls_Description
string ls_Query
string ls_Is_enabled
string ls_Name
string ls_Id
string ls_DataId
string ls_V_Type
string ls_DataType
string ls_Version
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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>"
// }
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("data.type","sensitive_data_scanner_group")
loo_Json.UpdateString("data.attributes.description","<string>")
loo_Json.UpdateString("data.attributes.filter.query","<string>")
loo_Json.UpdateString("data.attributes.is_enabled","<boolean>")
loo_Json.UpdateString("data.attributes.name","<string>")
loo_Json.UpdateString("data.attributes.product_list[0]","logs")
loo_Json.UpdateString("data.attributes.product_list[1]","logs")
loo_Json.UpdateString("data.relationships.configuration.data.id","<string>")
loo_Json.UpdateString("data.relationships.configuration.data.type","sensitive_data_scanner_configuration")
loo_Json.UpdateString("data.relationships.rules.data[0].id","<string>")
loo_Json.UpdateString("data.relationships.rules.data[0].type","sensitive_data_scanner_rule")
loo_Json.UpdateString("data.relationships.rules.data[1].id","<string>")
loo_Json.UpdateString("data.relationships.rules.data[1].type","sensitive_data_scanner_rule")
loo_Json.UpdateString("meta.version","<long>")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.PostJson3("https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/groups","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
ls_Description = loo_JResp.StringOf("data.attributes.description")
ls_Query = loo_JResp.StringOf("data.attributes.filter.query")
ls_Is_enabled = loo_JResp.StringOf("data.attributes.is_enabled")
ls_Name = loo_JResp.StringOf("data.attributes.name")
ls_Id = loo_JResp.StringOf("data.id")
ls_DataId = loo_JResp.StringOf("data.relationships.configuration.data.id")
ls_V_Type = loo_JResp.StringOf("data.relationships.configuration.data.type")
ls_DataType = loo_JResp.StringOf("data.type")
ls_Version = loo_JResp.StringOf("meta.version")
i = 0
li_Count_i = loo_JResp.SizeOfArray("data.attributes.product_list")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("data.attributes.product_list[i]")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("data.relationships.rules.data")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("data.relationships.rules.data[i].id")
ls_V_type = loo_JResp.StringOf("data.relationships.rules.data[i].type")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
