Chilkat Online Tools

Xojo / Datadog API Collection / Get a rule's details

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/security_monitoring/rules/:rule_id",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

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

// {
//   "cases": [
//     {
//       "condition": "<string>",
//       "name": "<string>",
//       "notifications": [
//         "<string>",
//         "<string>"
//       ],
//       "status": "medium"
//     },
//     {
//       "condition": "<string>",
//       "name": "<string>",
//       "notifications": [
//         "<string>",
//         "<string>"
//       ],
//       "status": "critical"
//     }
//   ],
//   "complianceSignalOptions": {
//     "defaultActivationStatus": "<boolean>",
//     "defaultGroupByFields": [
//       "<string>",
//       "<string>"
//     ],
//     "userActivationStatus": "<boolean>",
//     "userGroupByFields": [
//       "<string>",
//       "<string>"
//     ]
//   },
//   "createdAt": "<long>",
//   "creationAuthorId": "<long>",
//   "deprecationDate": "<long>",
//   "filters": [
//     {
//       "action": "suppress",
//       "query": "<string>"
//     },
//     {
//       "action": "require",
//       "query": "<string>"
//     }
//   ],
//   "hasExtendedTitle": "<boolean>",
//   "id": "<string>",
//   "isDefault": "<boolean>",
//   "isDeleted": "<boolean>",
//   "isEnabled": "<boolean>",
//   "message": "<string>",
//   "name": "<string>",
//   "options": {
//     "complianceRuleOptions": {
//       "complexRule": "<boolean>",
//       "regoRule": {
//         "policy": "<string>",
//         "resourceTypes": [
//           "<string>",
//           "<string>"
//         ]
//       },
//       "resourceType": "<string>"
//     },
//     "decreaseCriticalityBasedOnEnv": "<boolean>",
//     "detectionMethod": "third_party",
//     "evaluationWindow": 300,
//     "hardcodedEvaluatorType": "log4shell",
//     "impossibleTravelOptions": {
//       "baselineUserLocations": "<boolean>"
//     },
//     "keepAlive": 300,
//     "maxSignalDuration": 900,
//     "newValueOptions": {
//       "forgetAfter": 28,
//       "learningDuration": 0,
//       "learningMethod": "duration",
//       "learningThreshold": 0
//     }
//   },
//   "queries": [
//     {
//       "aggregation": "max",
//       "distinctFields": [
//         "<string>",
//         "<string>"
//       ],
//       "groupByFields": [
//         "<string>",
//         "<string>"
//       ],
//       "metric": "<string>",
//       "metrics": [
//         "<string>",
//         "<string>"
//       ],
//       "name": "<string>",
//       "query": "<string>"
//     },
//     {
//       "aggregation": "max",
//       "distinctFields": [
//         "<string>",
//         "<string>"
//       ],
//       "groupByFields": [
//         "<string>",
//         "<string>"
//       ],
//       "metric": "<string>",
//       "metrics": [
//         "<string>",
//         "<string>"
//       ],
//       "name": "<string>",
//       "query": "<string>"
//     }
//   ],
//   "tags": [
//     "<string>",
//     "<string>"
//   ],
//   "type": "application_security",
//   "updateAuthorId": "<long>",
//   "version": "<long>"
// }

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

Dim condition As String
Dim status As String
Dim j As Int32
Dim count_j As Int32
Dim strVal As String
Dim action As String
Dim query As String
Dim aggregation As String
Dim metric As String

Dim DefaultActivationStatus As String
DefaultActivationStatus = jResp.StringOf("complianceSignalOptions.defaultActivationStatus")
Dim UserActivationStatus As String
UserActivationStatus = jResp.StringOf("complianceSignalOptions.userActivationStatus")
Dim createdAt As String
createdAt = jResp.StringOf("createdAt")
Dim creationAuthorId As String
creationAuthorId = jResp.StringOf("creationAuthorId")
Dim deprecationDate As String
deprecationDate = jResp.StringOf("deprecationDate")
Dim hasExtendedTitle As String
hasExtendedTitle = jResp.StringOf("hasExtendedTitle")
Dim id As String
id = jResp.StringOf("id")
Dim isDefault As String
isDefault = jResp.StringOf("isDefault")
Dim isDeleted As String
isDeleted = jResp.StringOf("isDeleted")
Dim isEnabled As String
isEnabled = jResp.StringOf("isEnabled")
Dim message As String
message = jResp.StringOf("message")
Dim name As String
name = jResp.StringOf("name")
Dim ComplexRule As String
ComplexRule = jResp.StringOf("options.complianceRuleOptions.complexRule")
Dim Policy As String
Policy = jResp.StringOf("options.complianceRuleOptions.regoRule.policy")
Dim ResourceType As String
ResourceType = jResp.StringOf("options.complianceRuleOptions.resourceType")
Dim DecreaseCriticalityBasedOnEnv As String
DecreaseCriticalityBasedOnEnv = jResp.StringOf("options.decreaseCriticalityBasedOnEnv")
Dim DetectionMethod As String
DetectionMethod = jResp.StringOf("options.detectionMethod")
Dim EvaluationWindow As Int32
EvaluationWindow = jResp.IntOf("options.evaluationWindow")
Dim HardcodedEvaluatorType As String
HardcodedEvaluatorType = jResp.StringOf("options.hardcodedEvaluatorType")
Dim BaselineUserLocations As String
BaselineUserLocations = jResp.StringOf("options.impossibleTravelOptions.baselineUserLocations")
Dim KeepAlive As Int32
KeepAlive = jResp.IntOf("options.keepAlive")
Dim MaxSignalDuration As Int32
MaxSignalDuration = jResp.IntOf("options.maxSignalDuration")
Dim ForgetAfter As Int32
ForgetAfter = jResp.IntOf("options.newValueOptions.forgetAfter")
Dim LearningDuration As Int32
LearningDuration = jResp.IntOf("options.newValueOptions.learningDuration")
Dim LearningMethod As String
LearningMethod = jResp.StringOf("options.newValueOptions.learningMethod")
Dim LearningThreshold As Int32
LearningThreshold = jResp.IntOf("options.newValueOptions.learningThreshold")
Dim v_type As String
v_type = jResp.StringOf("type")
Dim updateAuthorId As String
updateAuthorId = jResp.StringOf("updateAuthorId")
Dim version As String
version = jResp.StringOf("version")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("cases")
While i < count_i
    jResp.I = i
    condition = jResp.StringOf("cases[i].condition")
    name = jResp.StringOf("cases[i].name")
    status = jResp.StringOf("cases[i].status")
    j = 0
    count_j = jResp.SizeOfArray("cases[i].notifications")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("cases[i].notifications[j]")
        j = j + 1
    Wend
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("complianceSignalOptions.defaultGroupByFields")
While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("complianceSignalOptions.defaultGroupByFields[i]")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("complianceSignalOptions.userGroupByFields")
While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("complianceSignalOptions.userGroupByFields[i]")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("filters")
While i < count_i
    jResp.I = i
    action = jResp.StringOf("filters[i].action")
    query = jResp.StringOf("filters[i].query")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("options.complianceRuleOptions.regoRule.resourceTypes")
While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("options.complianceRuleOptions.regoRule.resourceTypes[i]")
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("queries")
While i < count_i
    jResp.I = i
    aggregation = jResp.StringOf("queries[i].aggregation")
    metric = jResp.StringOf("queries[i].metric")
    name = jResp.StringOf("queries[i].name")
    query = jResp.StringOf("queries[i].query")
    j = 0
    count_j = jResp.SizeOfArray("queries[i].distinctFields")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("queries[i].distinctFields[j]")
        j = j + 1
    Wend
    j = 0
    count_j = jResp.SizeOfArray("queries[i].groupByFields")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("queries[i].groupByFields[j]")
        j = j + 1
    Wend
    j = 0
    count_j = jResp.SizeOfArray("queries[i].metrics")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("queries[i].metrics[j]")
        j = j + 1
    Wend
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("tags")
While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("tags[i]")
    i = i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get a rule's details",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/security_monitoring/rules/:rule_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "security_monitoring",
        "rules",
        ":rule_id"
      ],
      "variable": [
        {
          "key": "rule_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Get a rule's details."
  },
  "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/rules/:rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "rules",
            ":rule_id"
          ],
          "variable": [
            {
              "key": "rule_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"cases\": [\n    {\n      \"condition\": \"<string>\",\n      \"name\": \"<string>\",\n      \"notifications\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"status\": \"medium\"\n    },\n    {\n      \"condition\": \"<string>\",\n      \"name\": \"<string>\",\n      \"notifications\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"status\": \"critical\"\n    }\n  ],\n  \"complianceSignalOptions\": {\n    \"defaultActivationStatus\": \"<boolean>\",\n    \"defaultGroupByFields\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"userActivationStatus\": \"<boolean>\",\n    \"userGroupByFields\": [\n      \"<string>\",\n      \"<string>\"\n    ]\n  },\n  \"createdAt\": \"<long>\",\n  \"creationAuthorId\": \"<long>\",\n  \"deprecationDate\": \"<long>\",\n  \"filters\": [\n    {\n      \"action\": \"suppress\",\n      \"query\": \"<string>\"\n    },\n    {\n      \"action\": \"require\",\n      \"query\": \"<string>\"\n    }\n  ],\n  \"hasExtendedTitle\": \"<boolean>\",\n  \"id\": \"<string>\",\n  \"isDefault\": \"<boolean>\",\n  \"isDeleted\": \"<boolean>\",\n  \"isEnabled\": \"<boolean>\",\n  \"message\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": {\n    \"complianceRuleOptions\": {\n      \"complexRule\": \"<boolean>\",\n      \"regoRule\": {\n        \"policy\": \"<string>\",\n        \"resourceTypes\": [\n          \"<string>\",\n          \"<string>\"\n        ]\n      },\n      \"resourceType\": \"<string>\"\n    },\n    \"decreaseCriticalityBasedOnEnv\": \"<boolean>\",\n    \"detectionMethod\": \"third_party\",\n    \"evaluationWindow\": 300,\n    \"hardcodedEvaluatorType\": \"log4shell\",\n    \"impossibleTravelOptions\": {\n      \"baselineUserLocations\": \"<boolean>\"\n    },\n    \"keepAlive\": 300,\n    \"maxSignalDuration\": 900,\n    \"newValueOptions\": {\n      \"forgetAfter\": 28,\n      \"learningDuration\": 0,\n      \"learningMethod\": \"duration\",\n      \"learningThreshold\": 0\n    }\n  },\n  \"queries\": [\n    {\n      \"aggregation\": \"max\",\n      \"distinctFields\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"groupByFields\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"metric\": \"<string>\",\n      \"metrics\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"name\": \"<string>\",\n      \"query\": \"<string>\"\n    },\n    {\n      \"aggregation\": \"max\",\n      \"distinctFields\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"groupByFields\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"metric\": \"<string>\",\n      \"metrics\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"name\": \"<string>\",\n      \"query\": \"<string>\"\n    }\n  ],\n  \"tags\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"type\": \"application_security\",\n  \"updateAuthorId\": \"<long>\",\n  \"version\": \"<long>\"\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/rules/:rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "rules",
            ":rule_id"
          ],
          "variable": [
            {
              "key": "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/rules/:rule_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "security_monitoring",
            "rules",
            ":rule_id"
          ],
          "variable": [
            {
              "key": "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}"
    }
  ]
}