Chilkat Online Tools

C++ / Datadog API Collection / Update Scanning Group

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.h>

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

    CkHttp http;
    bool success;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "data": {
    //     "attributes": {
    //       "description": "<string>",
    //       "filter": {
    //         "query": "<string>"
    //       },
    //       "is_enabled": "<boolean>",
    //       "name": "<string>",
    //       "product_list": [
    //         "logs",
    //         "logs"
    //       ]
    //     },
    //     "id": "<string>",
    //     "relationships": {
    //       "configuration": {
    //         "data": {
    //           "id": "<string>",
    //           "type": "sensitive_data_scanner_configuration"
    //         }
    //       },
    //       "rules": {
    //         "data": [
    //           {
    //             "id": "<string>",
    //             "type": "sensitive_data_scanner_rule"
    //           },
    //           {
    //             "id": "<string>",
    //             "type": "sensitive_data_scanner_rule"
    //           }
    //         ]
    //       }
    //     },
    //     "type": "sensitive_data_scanner_group"
    //   },
    //   "meta": {
    //     "version": "<long>"
    //   }
    // }

    CkJsonObject json;
    json.UpdateString("data.attributes.description","<string>");
    json.UpdateString("data.attributes.filter.query","<string>");
    json.UpdateString("data.attributes.is_enabled","<boolean>");
    json.UpdateString("data.attributes.name","<string>");
    json.UpdateString("data.attributes.product_list[0]","logs");
    json.UpdateString("data.attributes.product_list[1]","logs");
    json.UpdateString("data.id","<string>");
    json.UpdateString("data.relationships.configuration.data.id","<string>");
    json.UpdateString("data.relationships.configuration.data.type","sensitive_data_scanner_configuration");
    json.UpdateString("data.relationships.rules.data[0].id","<string>");
    json.UpdateString("data.relationships.rules.data[0].type","sensitive_data_scanner_rule");
    json.UpdateString("data.relationships.rules.data[1].id","<string>");
    json.UpdateString("data.relationships.rules.data[1].type","sensitive_data_scanner_rule");
    json.UpdateString("data.type","sensitive_data_scanner_group");
    json.UpdateString("meta.version","<long>");

    http.SetRequestHeader("Content-Type","application/json");
    http.SetRequestHeader("Accept","application/json");

    CkStringBuilder sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponse *resp = http.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/groups/:group_id",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

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

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "meta": {
    //     "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 char *Version = jResp.stringOf("meta.version");
    }

Curl Command

curl -X PATCH
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "attributes": {
      "description": "<string>",
      "filter": {
        "query": "<string>"
      },
      "is_enabled": "<boolean>",
      "name": "<string>",
      "product_list": [
        "logs",
        "logs"
      ]
    },
    "id": "<string>",
    "relationships": {
      "configuration": {
        "data": {
          "id": "<string>",
          "type": "sensitive_data_scanner_configuration"
        }
      },
      "rules": {
        "data": [
          {
            "id": "<string>",
            "type": "sensitive_data_scanner_rule"
          },
          {
            "id": "<string>",
            "type": "sensitive_data_scanner_rule"
          }
        ]
      }
    },
    "type": "sensitive_data_scanner_group"
  },
  "meta": {
    "version": "<long>"
  }
}'
https://api.app.ddog-gov.com/api/v2/sensitive-data-scanner/config/groups/:group_id

Postman Collection Item JSON

{
  "name": "Update Scanning Group",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"description\": \"<string>\",\n      \"filter\": {\n        \"query\": \"<string>\"\n      },\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"product_list\": [\n        \"logs\",\n        \"logs\"\n      ]\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"configuration\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_configuration\"\n        }\n      },\n      \"rules\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          }\n        ]\n      }\n    },\n    \"type\": \"sensitive_data_scanner_group\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "sensitive-data-scanner",
        "config",
        "groups",
        ":group_id"
      ],
      "variable": [
        {
          "key": "group_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Update a group, including the order of the rules.\nRules within the group are reordered by including a rules relationship. If the rules\nrelationship is present, its data section MUST contain linkages for all of the rules\ncurrently in the group, and MUST NOT contain any others."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"description\": \"<string>\",\n      \"filter\": {\n        \"query\": \"<string>\"\n      },\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"product_list\": [\n        \"logs\",\n        \"logs\"\n      ]\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"configuration\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_configuration\"\n        }\n      },\n      \"rules\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          }\n        ]\n      }\n    },\n    \"type\": \"sensitive_data_scanner_group\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "groups",
            ":group_id"
          ],
          "variable": [
            {
              "key": "group_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"description\": \"<string>\",\n      \"filter\": {\n        \"query\": \"<string>\"\n      },\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"product_list\": [\n        \"logs\",\n        \"logs\"\n      ]\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"configuration\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_configuration\"\n        }\n      },\n      \"rules\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          }\n        ]\n      }\n    },\n    \"type\": \"sensitive_data_scanner_group\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "groups",
            ":group_id"
          ],
          "variable": [
            {
              "key": "group_id"
            }
          ]
        }
      },
      "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": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"description\": \"<string>\",\n      \"filter\": {\n        \"query\": \"<string>\"\n      },\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"product_list\": [\n        \"logs\",\n        \"logs\"\n      ]\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"configuration\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_configuration\"\n        }\n      },\n      \"rules\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          }\n        ]\n      }\n    },\n    \"type\": \"sensitive_data_scanner_group\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "groups",
            ":group_id"
          ],
          "variable": [
            {
              "key": "group_id"
            }
          ]
        }
      },
      "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": "Not Found",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"description\": \"<string>\",\n      \"filter\": {\n        \"query\": \"<string>\"\n      },\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"product_list\": [\n        \"logs\",\n        \"logs\"\n      ]\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"configuration\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_configuration\"\n        }\n      },\n      \"rules\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          }\n        ]\n      }\n    },\n    \"type\": \"sensitive_data_scanner_group\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "groups",
            ":group_id"
          ],
          "variable": [
            {
              "key": "group_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_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": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"description\": \"<string>\",\n      \"filter\": {\n        \"query\": \"<string>\"\n      },\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"product_list\": [\n        \"logs\",\n        \"logs\"\n      ]\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"configuration\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"sensitive_data_scanner_configuration\"\n        }\n      },\n      \"rules\": {\n        \"data\": [\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          },\n          {\n            \"id\": \"<string>\",\n            \"type\": \"sensitive_data_scanner_rule\"\n          }\n        ]\n      }\n    },\n    \"type\": \"sensitive_data_scanner_group\"\n  },\n  \"meta\": {\n    \"version\": \"<long>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/sensitive-data-scanner/config/groups/:group_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sensitive-data-scanner",
            "config",
            "groups",
            ":group_id"
          ],
          "variable": [
            {
              "key": "group_id"
            }
          ]
        }
      },
      "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}"
    }
  ]
}