Chilkat Online Tools

unicodeCpp / Datadog API Collection / List Scanning Groups

Back to Collection Items

#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttpW http;
    bool success;

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

    CkStringBuilderW sbResponseBody;
    success = http.QuickGetSb(L"https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config",sbResponseBody);
    if (success == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = http.get_LastStatus();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",http.lastHeader());
        wprintf(L"Failed.\n");
        return;
    }

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const wchar_t *id = 0;
    const wchar_t *v_type = 0;
    const wchar_t *Description = 0;
    const wchar_t *Is_enabled = 0;
    const wchar_t *Name = 0;
    const wchar_t *Pattern = 0;
    const wchar_t *Number_of_chars = 0;
    const wchar_t *Replacement_string = 0;
    const wchar_t *Text_replacementType = 0;
    const wchar_t *DataId = 0;
    const wchar_t *DataType = 0;
    int j;
    int count_j;
    const wchar_t *strVal = 0;

    const wchar_t *Id = jResp.stringOf(L"data.id");
    const wchar_t *v_Type = jResp.stringOf(L"data.type");
    const wchar_t *Count_limit = jResp.stringOf(L"meta.count_limit");
    const wchar_t *Group_count_limit = jResp.stringOf(L"meta.group_count_limit");
    const wchar_t *Has_highlight_enabled = jResp.stringOf(L"meta.has_highlight_enabled");
    const wchar_t *Has_multi_pass_enabled = jResp.stringOf(L"meta.has_multi_pass_enabled");
    const wchar_t *Is_pci_compliant = jResp.stringOf(L"meta.is_pci_compliant");
    const wchar_t *Version = jResp.stringOf(L"meta.version");
    int i = 0;
    int count_i = jResp.SizeOfArray(L"data.relationships.groups.data");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf(L"data.relationships.groups.data[i].id");
        v_type = jResp.stringOf(L"data.relationships.groups.data[i].type");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"included");
    while (i < count_i) {
        jResp.put_I(i);
        Description = jResp.stringOf(L"included[i].attributes.description");
        Is_enabled = jResp.stringOf(L"included[i].attributes.is_enabled");
        Name = jResp.stringOf(L"included[i].attributes.name");
        Pattern = jResp.stringOf(L"included[i].attributes.pattern");
        Number_of_chars = jResp.stringOf(L"included[i].attributes.text_replacement.number_of_chars");
        Replacement_string = jResp.stringOf(L"included[i].attributes.text_replacement.replacement_string");
        Text_replacementType = jResp.stringOf(L"included[i].attributes.text_replacement.type");
        id = jResp.stringOf(L"included[i].id");
        DataId = jResp.stringOf(L"included[i].relationships.group.data.id");
        DataType = jResp.stringOf(L"included[i].relationships.group.data.type");
        DataId = jResp.stringOf(L"included[i].relationships.standard_pattern.data.id");
        DataType = jResp.stringOf(L"included[i].relationships.standard_pattern.data.type");
        v_type = jResp.stringOf(L"included[i].type");
        j = 0;
        count_j = jResp.SizeOfArray(L"included[i].attributes.excluded_namespaces");
        while (j < count_j) {
            jResp.put_J(j);
            strVal = jResp.stringOf(L"included[i].attributes.excluded_namespaces[j]");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray(L"included[i].attributes.namespaces");
        while (j < count_j) {
            jResp.put_J(j);
            strVal = jResp.stringOf(L"included[i].attributes.namespaces[j]");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray(L"included[i].attributes.tags");
        while (j < count_j) {
            jResp.put_J(j);
            strVal = jResp.stringOf(L"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}"
    }
  ]
}