Chilkat Online Tools

C++ / Datadog API Collection / Get a security filter

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.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;

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

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

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

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

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

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

    // {
    //   "data": {
    //     "attributes": {
    //       "exclusion_filters": [
    //         {
    //           "name": "<string>",
    //           "query": "<string>"
    //         },
    //         {
    //           "name": "<string>",
    //           "query": "<string>"
    //         }
    //       ],
    //       "filtered_data_type": "logs",
    //       "is_builtin": "<boolean>",
    //       "is_enabled": "<boolean>",
    //       "name": "<string>",
    //       "query": "<string>",
    //       "version": "<integer>"
    //     },
    //     "id": "<string>",
    //     "type": "security_filters"
    //   },
    //   "meta": {
    //     "warning": "<string>"
    //   }
    // }

    // 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 *name = 0;
    const char *query = 0;

    const char *Filtered_data_type = jResp.stringOf("data.attributes.filtered_data_type");
    const char *Is_builtin = jResp.stringOf("data.attributes.is_builtin");
    const char *Is_enabled = jResp.stringOf("data.attributes.is_enabled");
    const char *Name = jResp.stringOf("data.attributes.name");
    const char *Query = jResp.stringOf("data.attributes.query");
    const char *Version = jResp.stringOf("data.attributes.version");
    const char *Id = jResp.stringOf("data.id");
    const char *v_Type = jResp.stringOf("data.type");
    const char *Warning = jResp.stringOf("meta.warning");
    int i = 0;
    int count_i = jResp.SizeOfArray("data.attributes.exclusion_filters");
    while (i < count_i) {
        jResp.put_I(i);
        name = jResp.stringOf("data.attributes.exclusion_filters[i].name");
        query = jResp.stringOf("data.attributes.exclusion_filters[i].query");
        i = i + 1;
    }
    }

Curl Command

curl -X GET
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/security_monitoring/configuration/security_filters/:security_filter_id

Postman Collection Item JSON

{
  "name": "Get a security filter",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "security_monitoring",
        "configuration",
        "security_filters",
        ":security_filter_id"
      ],
      "variable": [
        {
          "key": "security_filter_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Get the details of a specific security filter.\n\nSee the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/)\nfor more examples."
  },
  "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/security_monitoring/configuration/security_filters/:security_filter_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "configuration",
            "security_filters",
            ":security_filter_id"
          ],
          "variable": [
            {
              "key": "security_filter_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"attributes\": {\n      \"exclusion_filters\": [\n        {\n          \"name\": \"<string>\",\n          \"query\": \"<string>\"\n        },\n        {\n          \"name\": \"<string>\",\n          \"query\": \"<string>\"\n        }\n      ],\n      \"filtered_data_type\": \"logs\",\n      \"is_builtin\": \"<boolean>\",\n      \"is_enabled\": \"<boolean>\",\n      \"name\": \"<string>\",\n      \"query\": \"<string>\",\n      \"version\": \"<integer>\"\n    },\n    \"id\": \"<string>\",\n    \"type\": \"security_filters\"\n  },\n  \"meta\": {\n    \"warning\": \"<string>\"\n  }\n}"
    },
    {
      "name": "Not Authorized",
      "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/security_monitoring/configuration/security_filters/:security_filter_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "configuration",
            "security_filters",
            ":security_filter_id"
          ],
          "variable": [
            {
              "key": "security_filter_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": "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/security_monitoring/configuration/security_filters/:security_filter_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "configuration",
            "security_filters",
            ":security_filter_id"
          ],
          "variable": [
            {
              "key": "security_filter_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": "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/security_monitoring/configuration/security_filters/:security_filter_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "configuration",
            "security_filters",
            ":security_filter_id"
          ],
          "variable": [
            {
              "key": "security_filter_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}"
    }
  ]
}