Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcV_type
LOCAL lcDescription
LOCAL lcIs_enabled
LOCAL lcName
LOCAL lcPattern
LOCAL lcNumber_of_chars
LOCAL lcReplacement_string
LOCAL lcText_replacementType
LOCAL lcDataId
LOCAL lcDataType
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
LOCAL lcId
LOCAL lcV_Type
LOCAL lcCount_limit
LOCAL lcGroup_count_limit
LOCAL lcHas_highlight_enabled
LOCAL lcHas_multi_pass_enabled
LOCAL lcIs_pci_compliant
LOCAL lcVersion
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lcId = loJResp.StringOf("data.id")
lcV_Type = loJResp.StringOf("data.type")
lcCount_limit = loJResp.StringOf("meta.count_limit")
lcGroup_count_limit = loJResp.StringOf("meta.group_count_limit")
lcHas_highlight_enabled = loJResp.StringOf("meta.has_highlight_enabled")
lcHas_multi_pass_enabled = loJResp.StringOf("meta.has_multi_pass_enabled")
lcIs_pci_compliant = loJResp.StringOf("meta.is_pci_compliant")
lcVersion = loJResp.StringOf("meta.version")
i = 0
lnCount_i = loJResp.SizeOfArray("data.relationships.groups.data")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("data.relationships.groups.data[i].id")
lcV_type = loJResp.StringOf("data.relationships.groups.data[i].type")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("included")
DO WHILE i < lnCount_i
loJResp.I = i
lcDescription = loJResp.StringOf("included[i].attributes.description")
lcIs_enabled = loJResp.StringOf("included[i].attributes.is_enabled")
lcName = loJResp.StringOf("included[i].attributes.name")
lcPattern = loJResp.StringOf("included[i].attributes.pattern")
lcNumber_of_chars = loJResp.StringOf("included[i].attributes.text_replacement.number_of_chars")
lcReplacement_string = loJResp.StringOf("included[i].attributes.text_replacement.replacement_string")
lcText_replacementType = loJResp.StringOf("included[i].attributes.text_replacement.type")
lcId = loJResp.StringOf("included[i].id")
lcDataId = loJResp.StringOf("included[i].relationships.group.data.id")
lcDataType = loJResp.StringOf("included[i].relationships.group.data.type")
lcDataId = loJResp.StringOf("included[i].relationships.standard_pattern.data.id")
lcDataType = loJResp.StringOf("included[i].relationships.standard_pattern.data.type")
lcV_type = loJResp.StringOf("included[i].type")
j = 0
lnCount_j = loJResp.SizeOfArray("included[i].attributes.excluded_namespaces")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("included[i].attributes.excluded_namespaces[j]")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("included[i].attributes.namespaces")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("included[i].attributes.namespaces[j]")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("included[i].attributes.tags")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("included[i].attributes.tags[j]")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
