Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "attributes": {
; "ametf": {},
; "ead6": {},
; "dolore03e": {}
; },
; "id": "<string>",
; "relationships": {
; "groups": {
; "data": [
; {
; "id": "<string>",
; "type": "sensitive_data_scanner_group"
; },
; {
; "id": "<string>",
; "type": "sensitive_data_scanner_group"
; }
; ]
; }
; },
; "type": "sensitive_data_scanner_configuration"
; },
; "included": [
; {
; "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"
; },
; {
; "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": {
; "count_limit": "<long>",
; "group_count_limit": "<long>",
; "has_highlight_enabled": "<boolean>",
; "has_multi_pass_enabled": "<boolean>",
; "is_pci_compliant": "<boolean>",
; "version": "<long>"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sId
Local $sV_type
Local $sDescription
Local $sIs_enabled
Local $sName
Local $sPattern
Local $sNumber_of_chars
Local $sReplacement_string
Local $sText_replacementType
Local $sDataId
Local $sDataType
Local $iJ
Local $iCount_j
Local $strVal
Local $sId = $oJResp.StringOf("data.id")
Local $sV_Type = $oJResp.StringOf("data.type")
Local $sCount_limit = $oJResp.StringOf("meta.count_limit")
Local $sGroup_count_limit = $oJResp.StringOf("meta.group_count_limit")
Local $sHas_highlight_enabled = $oJResp.StringOf("meta.has_highlight_enabled")
Local $sHas_multi_pass_enabled = $oJResp.StringOf("meta.has_multi_pass_enabled")
Local $sIs_pci_compliant = $oJResp.StringOf("meta.is_pci_compliant")
Local $sVersion = $oJResp.StringOf("meta.version")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.relationships.groups.data")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("data.relationships.groups.data[i].id")
$sV_type = $oJResp.StringOf("data.relationships.groups.data[i].type")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("included")
While $i < $iCount_i
$oJResp.I = $i
$sDescription = $oJResp.StringOf("included[i].attributes.description")
$sIs_enabled = $oJResp.StringOf("included[i].attributes.is_enabled")
$sName = $oJResp.StringOf("included[i].attributes.name")
$sPattern = $oJResp.StringOf("included[i].attributes.pattern")
$sNumber_of_chars = $oJResp.StringOf("included[i].attributes.text_replacement.number_of_chars")
$sReplacement_string = $oJResp.StringOf("included[i].attributes.text_replacement.replacement_string")
$sText_replacementType = $oJResp.StringOf("included[i].attributes.text_replacement.type")
$sId = $oJResp.StringOf("included[i].id")
$sDataId = $oJResp.StringOf("included[i].relationships.group.data.id")
$sDataType = $oJResp.StringOf("included[i].relationships.group.data.type")
$sDataId = $oJResp.StringOf("included[i].relationships.standard_pattern.data.id")
$sDataType = $oJResp.StringOf("included[i].relationships.standard_pattern.data.type")
$sV_type = $oJResp.StringOf("included[i].type")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("included[i].attributes.excluded_namespaces")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("included[i].attributes.excluded_namespaces[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("included[i].attributes.namespaces")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("included[i].attributes.namespaces[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("included[i].attributes.tags")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("included[i].attributes.tags[j]")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config
Postman Collection Item JSON
{
"name": "List Scanning Groups",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
},
"description": "List all the Scanning groups in your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"ametf\": {},\n \"ead6\": {},\n \"dolore03e\": {}\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"groups\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"sensitive_data_scanner_group\"\n }\n ]\n }\n },\n \"type\": \"sensitive_data_scanner_configuration\"\n },\n \"included\": [\n {\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 {\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 ],\n \"meta\": {\n \"count_limit\": \"<long>\",\n \"group_count_limit\": \"<long>\",\n \"has_highlight_enabled\": \"<boolean>\",\n \"has_multi_pass_enabled\": \"<boolean>\",\n \"is_pci_compliant\": \"<boolean>\",\n \"version\": \"<long>\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"sensitive-data-scanner",
"config"
]
}
},
"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}"
}
]
}
