Chilkat Online Tools

Ruby / Datadog API Collection / List Scanning Groups

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.SetRequestHeader("Accept","application/json")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# 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 < count_i
    jResp.put_I(i)
    id = jResp.stringOf("data.relationships.groups.data[i].id")
    v_type = jResp.stringOf("data.relationships.groups.data[i].type")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("included")
while i < count_i
    jResp.put_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 < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("included[i].attributes.excluded_namespaces[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("included[i].attributes.namespaces")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("included[i].attributes.namespaces[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("included[i].attributes.tags")
    while j < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("included[i].attributes.tags[j]")
        j = j + 1
    end
    i = i + 1
end

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}"
    }
  ]
}