Chilkat Online Tools

lianja / Datadog API Collection / Get a Cloud Workload Security Agent rule

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/cloud_workload_security/agent_rules/:agent_rule_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": {
//       "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

lcAgentConstraint = loJResp.StringOf("data.attributes.agentConstraint")
lcCategory = loJResp.StringOf("data.attributes.category")
lcCreationAuthorUuId = loJResp.StringOf("data.attributes.creationAuthorUuId")
lcCreationDate = loJResp.StringOf("data.attributes.creationDate")
lcHandle = loJResp.StringOf("data.attributes.creator.handle")
lcName = loJResp.StringOf("data.attributes.creator.name")
lcDefaultRule = loJResp.StringOf("data.attributes.defaultRule")
lcDescription = loJResp.StringOf("data.attributes.description")
lcEnabled = loJResp.StringOf("data.attributes.enabled")
lcExpression = loJResp.StringOf("data.attributes.expression")
lcAttributesName = loJResp.StringOf("data.attributes.name")
lcUpdateAuthorUuId = loJResp.StringOf("data.attributes.updateAuthorUuId")
lcUpdateDate = loJResp.StringOf("data.attributes.updateDate")
lcUpdatedAt = loJResp.StringOf("data.attributes.updatedAt")
lcUpdaterHandle = loJResp.StringOf("data.attributes.updater.handle")
lcUpdaterName = loJResp.StringOf("data.attributes.updater.name")
lcVersion = loJResp.StringOf("data.attributes.version")
lcId = loJResp.StringOf("data.id")
lcV_Type = loJResp.StringOf("data.type")


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/cloud_workload_security/agent_rules/:agent_rule_id

Postman Collection Item JSON

{
  "name": "Get a Cloud Workload Security Agent rule",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "security_monitoring",
        "cloud_workload_security",
        "agent_rules",
        ":agent_rule_id"
      ],
      "variable": [
        {
          "key": "agent_rule_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Get the details of a specific Agent rule."
  },
  "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/:agent_rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "cloud_workload_security",
            "agent_rules",
            ":agent_rule_id"
          ],
          "variable": [
            {
              "key": "agent_rule_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\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}"
    },
    {
      "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/:agent_rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "cloud_workload_security",
            "agent_rules",
            ":agent_rule_id"
          ],
          "variable": [
            {
              "key": "agent_rule_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/cloud_workload_security/agent_rules/:agent_rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "cloud_workload_security",
            "agent_rules",
            ":agent_rule_id"
          ],
          "variable": [
            {
              "key": "agent_rule_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/cloud_workload_security/agent_rules/:agent_rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "cloud_workload_security",
            "agent_rules",
            ":agent_rule_id"
          ],
          "variable": [
            {
              "key": "agent_rule_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}"
    }
  ]
}