Chilkat Online Tools

delphiDll / Datadog API Collection / List Scanning Groups

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
v_type: PWideChar;
Description: PWideChar;
Is_enabled: PWideChar;
Name: PWideChar;
Pattern: PWideChar;
Number_of_chars: PWideChar;
Replacement_string: PWideChar;
Text_replacementType: PWideChar;
DataId: PWideChar;
DataType: PWideChar;
j: Integer;
count_j: Integer;
strVal: PWideChar;
Id: PWideChar;
v_Type: PWideChar;
Count_limit: PWideChar;
Group_count_limit: PWideChar;
Has_highlight_enabled: PWideChar;
Has_multi_pass_enabled: PWideChar;
Is_pci_compliant: PWideChar;
Version: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

CkHttp_SetRequestHeader(http,'Accept','application/json');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    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 := CkJsonObject__stringOf(jResp,'data.id');
v_Type := CkJsonObject__stringOf(jResp,'data.type');
Count_limit := CkJsonObject__stringOf(jResp,'meta.count_limit');
Group_count_limit := CkJsonObject__stringOf(jResp,'meta.group_count_limit');
Has_highlight_enabled := CkJsonObject__stringOf(jResp,'meta.has_highlight_enabled');
Has_multi_pass_enabled := CkJsonObject__stringOf(jResp,'meta.has_multi_pass_enabled');
Is_pci_compliant := CkJsonObject__stringOf(jResp,'meta.is_pci_compliant');
Version := CkJsonObject__stringOf(jResp,'meta.version');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data.relationships.groups.data');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    id := CkJsonObject__stringOf(jResp,'data.relationships.groups.data[i].id');
    v_type := CkJsonObject__stringOf(jResp,'data.relationships.groups.data[i].type');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'included');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    Description := CkJsonObject__stringOf(jResp,'included[i].attributes.description');
    Is_enabled := CkJsonObject__stringOf(jResp,'included[i].attributes.is_enabled');
    Name := CkJsonObject__stringOf(jResp,'included[i].attributes.name');
    Pattern := CkJsonObject__stringOf(jResp,'included[i].attributes.pattern');
    Number_of_chars := CkJsonObject__stringOf(jResp,'included[i].attributes.text_replacement.number_of_chars');
    Replacement_string := CkJsonObject__stringOf(jResp,'included[i].attributes.text_replacement.replacement_string');
    Text_replacementType := CkJsonObject__stringOf(jResp,'included[i].attributes.text_replacement.type');
    id := CkJsonObject__stringOf(jResp,'included[i].id');
    DataId := CkJsonObject__stringOf(jResp,'included[i].relationships.group.data.id');
    DataType := CkJsonObject__stringOf(jResp,'included[i].relationships.group.data.type');
    DataId := CkJsonObject__stringOf(jResp,'included[i].relationships.standard_pattern.data.id');
    DataType := CkJsonObject__stringOf(jResp,'included[i].relationships.standard_pattern.data.type');
    v_type := CkJsonObject__stringOf(jResp,'included[i].type');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'included[i].attributes.excluded_namespaces');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        strVal := CkJsonObject__stringOf(jResp,'included[i].attributes.excluded_namespaces[j]');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'included[i].attributes.namespaces');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        strVal := CkJsonObject__stringOf(jResp,'included[i].attributes.namespaces[j]');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'included[i].attributes.tags');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        strVal := CkJsonObject__stringOf(jResp,'included[i].attributes.tags[j]');
        j := j + 1;
      end;

    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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