Chilkat Online Tools

PureBasic / Datadog API Collection / Get all Cloud Workload Security Agent rules

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/cloud_workload_security/agent_rules",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": {
    ;         "agentConstraint": "<string>",
    ;         "category": "<string>",
    ;         "creationAuthorUuId": "<string>",
    ;         "creationDate": "<long>",
    ;         "creator": {
    ;           "handle": "<string>",
    ;           "name": "<string>"
    ;         },
    ;         "defaultRule": "<boolean>",
    ;         "description": "<string>",
    ;         "enabled": "<boolean>",
    ;         "expression": "<string>",
    ;         "name": "<string>",
    ;         "updateAuthorUuId": "<string>",
    ;         "updateDate": "<long>",
    ;         "updatedAt": "<long>",
    ;         "updater": {
    ;           "handle": "<string>",
    ;           "name": "<string>"
    ;         },
    ;         "version": "<long>"
    ;       },
    ;       "id": "<string>",
    ;       "type": "agent_rule"
    ;     },
    ;     {
    ;       "attributes": {
    ;         "agentConstraint": "<string>",
    ;         "category": "<string>",
    ;         "creationAuthorUuId": "<string>",
    ;         "creationDate": "<long>",
    ;         "creator": {
    ;           "handle": "<string>",
    ;           "name": "<string>"
    ;         },
    ;         "defaultRule": "<boolean>",
    ;         "description": "<string>",
    ;         "enabled": "<boolean>",
    ;         "expression": "<string>",
    ;         "name": "<string>",
    ;         "updateAuthorUuId": "<string>",
    ;         "updateDate": "<long>",
    ;         "updatedAt": "<long>",
    ;         "updater": {
    ;           "handle": "<string>",
    ;           "name": "<string>"
    ;         },
    ;         "version": "<long>"
    ;       },
    ;       "id": "<string>",
    ;       "type": "agent_rule"
    ;     }
    ;   ]
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    AgentConstraint.s
    Category.s
    CreationAuthorUuId.s
    CreationDate.s
    Handle.s
    Name.s
    DefaultRule.s
    Description.s
    Enabled.s
    Expression.s
    attributesName.s
    UpdateAuthorUuId.s
    UpdateDate.s
    UpdatedAt.s
    UpdaterHandle.s
    UpdaterName.s
    Version.s
    id.s
    v_type.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        AgentConstraint = CkJsonObject::ckStringOf(jResp,"data[i].attributes.agentConstraint")
        Category = CkJsonObject::ckStringOf(jResp,"data[i].attributes.category")
        CreationAuthorUuId = CkJsonObject::ckStringOf(jResp,"data[i].attributes.creationAuthorUuId")
        CreationDate = CkJsonObject::ckStringOf(jResp,"data[i].attributes.creationDate")
        Handle = CkJsonObject::ckStringOf(jResp,"data[i].attributes.creator.handle")
        Name = CkJsonObject::ckStringOf(jResp,"data[i].attributes.creator.name")
        DefaultRule = CkJsonObject::ckStringOf(jResp,"data[i].attributes.defaultRule")
        Description = CkJsonObject::ckStringOf(jResp,"data[i].attributes.description")
        Enabled = CkJsonObject::ckStringOf(jResp,"data[i].attributes.enabled")
        Expression = CkJsonObject::ckStringOf(jResp,"data[i].attributes.expression")
        attributesName = CkJsonObject::ckStringOf(jResp,"data[i].attributes.name")
        UpdateAuthorUuId = CkJsonObject::ckStringOf(jResp,"data[i].attributes.updateAuthorUuId")
        UpdateDate = CkJsonObject::ckStringOf(jResp,"data[i].attributes.updateDate")
        UpdatedAt = CkJsonObject::ckStringOf(jResp,"data[i].attributes.updatedAt")
        UpdaterHandle = CkJsonObject::ckStringOf(jResp,"data[i].attributes.updater.handle")
        UpdaterName = CkJsonObject::ckStringOf(jResp,"data[i].attributes.updater.name")
        Version = CkJsonObject::ckStringOf(jResp,"data[i].attributes.version")
        id = CkJsonObject::ckStringOf(jResp,"data[i].id")
        v_type = CkJsonObject::ckStringOf(jResp,"data[i].type")
        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/cloud_workload_security/agent_rules

Postman Collection Item JSON

{
  "name": "Get all Cloud Workload Security Agent rules",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "security_monitoring",
        "cloud_workload_security",
        "agent_rules"
      ]
    },
    "description": "Get the list of Agent rules."
  },
  "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/cloud_workload_security/agent_rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "cloud_workload_security",
            "agent_rules"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"attributes\": {\n        \"agentConstraint\": \"<string>\",\n        \"category\": \"<string>\",\n        \"creationAuthorUuId\": \"<string>\",\n        \"creationDate\": \"<long>\",\n        \"creator\": {\n          \"handle\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"defaultRule\": \"<boolean>\",\n        \"description\": \"<string>\",\n        \"enabled\": \"<boolean>\",\n        \"expression\": \"<string>\",\n        \"name\": \"<string>\",\n        \"updateAuthorUuId\": \"<string>\",\n        \"updateDate\": \"<long>\",\n        \"updatedAt\": \"<long>\",\n        \"updater\": {\n          \"handle\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"version\": \"<long>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"agent_rule\"\n    },\n    {\n      \"attributes\": {\n        \"agentConstraint\": \"<string>\",\n        \"category\": \"<string>\",\n        \"creationAuthorUuId\": \"<string>\",\n        \"creationDate\": \"<long>\",\n        \"creator\": {\n          \"handle\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"defaultRule\": \"<boolean>\",\n        \"description\": \"<string>\",\n        \"enabled\": \"<boolean>\",\n        \"expression\": \"<string>\",\n        \"name\": \"<string>\",\n        \"updateAuthorUuId\": \"<string>\",\n        \"updateDate\": \"<long>\",\n        \"updatedAt\": \"<long>\",\n        \"updater\": {\n          \"handle\": \"<string>\",\n          \"name\": \"<string>\"\n        },\n        \"version\": \"<long>\"\n      },\n      \"id\": \"<string>\",\n      \"type\": \"agent_rule\"\n    }\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/cloud_workload_security/agent_rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "cloud_workload_security",
            "agent_rules"
          ]
        }
      },
      "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/cloud_workload_security/agent_rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "cloud_workload_security",
            "agent_rules"
          ]
        }
      },
      "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}"
    }
  ]
}