Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$http.SetRequestHeader("Accept","application/json")
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config",$sbResponseBody)
if ($success -eq $false) {
$($http.LastErrorText)
exit
}
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($http.LastHeader)
$("Failed.")
exit
}
# 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
$Id = $jResp.StringOf("data.id")
$v_Type = $jResp.StringOf("data.type")
$Count_limit = $jResp.StringOf("meta.count_limit")
$Group_count_limit = $jResp.StringOf("meta.group_count_limit")
$Has_highlight_enabled = $jResp.StringOf("meta.has_highlight_enabled")
$Has_multi_pass_enabled = $jResp.StringOf("meta.has_multi_pass_enabled")
$Is_pci_compliant = $jResp.StringOf("meta.is_pci_compliant")
$Version = $jResp.StringOf("meta.version")
$i = 0
$count_i = $jResp.SizeOfArray("data.relationships.groups.data")
while ($i -lt $count_i) {
$jResp.I = $i
$id = $jResp.StringOf("data.relationships.groups.data[i].id")
$v_type = $jResp.StringOf("data.relationships.groups.data[i].type")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("included")
while ($i -lt $count_i) {
$jResp.I = $i
$Description = $jResp.StringOf("included[i].attributes.description")
$Is_enabled = $jResp.StringOf("included[i].attributes.is_enabled")
$Name = $jResp.StringOf("included[i].attributes.name")
$Pattern = $jResp.StringOf("included[i].attributes.pattern")
$Number_of_chars = $jResp.StringOf("included[i].attributes.text_replacement.number_of_chars")
$Replacement_string = $jResp.StringOf("included[i].attributes.text_replacement.replacement_string")
$Text_replacementType = $jResp.StringOf("included[i].attributes.text_replacement.type")
$id = $jResp.StringOf("included[i].id")
$DataId = $jResp.StringOf("included[i].relationships.group.data.id")
$DataType = $jResp.StringOf("included[i].relationships.group.data.type")
$DataId = $jResp.StringOf("included[i].relationships.standard_pattern.data.id")
$DataType = $jResp.StringOf("included[i].relationships.standard_pattern.data.type")
$v_type = $jResp.StringOf("included[i].type")
$j = 0
$count_j = $jResp.SizeOfArray("included[i].attributes.excluded_namespaces")
while ($j -lt $count_j) {
$jResp.J = $j
$strVal = $jResp.StringOf("included[i].attributes.excluded_namespaces[j]")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("included[i].attributes.namespaces")
while ($j -lt $count_j) {
$jResp.J = $j
$strVal = $jResp.StringOf("included[i].attributes.namespaces[j]")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("included[i].attributes.tags")
while ($j -lt $count_j) {
$jResp.J = $j
$strVal = $jResp.StringOf("included[i].attributes.tags[j]")
$j = $j + 1
}
$i = $i + 1
}
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}"
}
]
}
