Chilkat Online Tools

PureBasic / Datadog API Collection / Get all security filters

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://api.app.ddog-gov.com/api/v2/security_monitoring/configuration/security_filters",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    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"
    ;     },
    ;     {
    ;       "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

    Filtered_data_type.s
    Is_builtin.s
    Is_enabled.s
    Name.s
    Query.s
    Version.s
    id.s
    v_type.s
    j.i
    count_j.i
    name.s
    query.s

    Warning.s = CkJsonObject::ckStringOf(jResp,"meta.warning")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Filtered_data_type = CkJsonObject::ckStringOf(jResp,"data[i].attributes.filtered_data_type")
        Is_builtin = CkJsonObject::ckStringOf(jResp,"data[i].attributes.is_builtin")
        Is_enabled = CkJsonObject::ckStringOf(jResp,"data[i].attributes.is_enabled")
        Name = CkJsonObject::ckStringOf(jResp,"data[i].attributes.name")
        Query = CkJsonObject::ckStringOf(jResp,"data[i].attributes.query")
        Version = CkJsonObject::ckStringOf(jResp,"data[i].attributes.version")
        id = CkJsonObject::ckStringOf(jResp,"data[i].id")
        v_type = CkJsonObject::ckStringOf(jResp,"data[i].type")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].attributes.exclusion_filters")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            name = CkJsonObject::ckStringOf(jResp,"data[i].attributes.exclusion_filters[j].name")
            query = CkJsonObject::ckStringOf(jResp,"data[i].attributes.exclusion_filters[j].query")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get all security filters",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/security_monitoring/configuration/security_filters",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "security_monitoring",
        "configuration",
        "security_filters"
      ]
    },
    "description": "Get the list of configured security filters with their definitions."
  },
  "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "configuration",
            "security_filters"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\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    {\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  ],\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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "configuration",
            "security_filters"
          ]
        }
      },
      "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/security_monitoring/configuration/security_filters",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "configuration",
            "security_filters"
          ]
        }
      },
      "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}"
    }
  ]
}