Chilkat Online Tools

lianja / Datadog API Collection / Get a security filter

Back to Collection Items

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

loHttp = createobject("CkHttp")

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

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v2/security_monitoring/configuration/security_filters/:security_filter_id",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

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

lcFiltered_data_type = loJResp.StringOf("data.attributes.filtered_data_type")
lcIs_builtin = loJResp.StringOf("data.attributes.is_builtin")
lcIs_enabled = loJResp.StringOf("data.attributes.is_enabled")
lcName = loJResp.StringOf("data.attributes.name")
lcQuery = loJResp.StringOf("data.attributes.query")
lcVersion = loJResp.StringOf("data.attributes.version")
lcId = loJResp.StringOf("data.id")
lcV_Type = loJResp.StringOf("data.type")
lcWarning = loJResp.StringOf("meta.warning")
i = 0
lnCount_i = loJResp.SizeOfArray("data.attributes.exclusion_filters")
do while i < lnCount_i
    loJResp.I = i
    lcName = loJResp.StringOf("data.attributes.exclusion_filters[i].name")
    lcQuery = loJResp.StringOf("data.attributes.exclusion_filters[i].query")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

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