Chilkat Online Tools

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

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$http->SetRequestHeader('Accept','application/json');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://api.app.ddog-gov.com/api/v2/security_monitoring/rules/:rule_id',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

$DefaultActivationStatus = $jResp->stringOf('complianceSignalOptions.defaultActivationStatus');
$UserActivationStatus = $jResp->stringOf('complianceSignalOptions.userActivationStatus');
$createdAt = $jResp->stringOf('createdAt');
$creationAuthorId = $jResp->stringOf('creationAuthorId');
$deprecationDate = $jResp->stringOf('deprecationDate');
$hasExtendedTitle = $jResp->stringOf('hasExtendedTitle');
$id = $jResp->stringOf('id');
$isDefault = $jResp->stringOf('isDefault');
$isDeleted = $jResp->stringOf('isDeleted');
$isEnabled = $jResp->stringOf('isEnabled');
$message = $jResp->stringOf('message');
$name = $jResp->stringOf('name');
$ComplexRule = $jResp->stringOf('options.complianceRuleOptions.complexRule');
$Policy = $jResp->stringOf('options.complianceRuleOptions.regoRule.policy');
$ResourceType = $jResp->stringOf('options.complianceRuleOptions.resourceType');
$DecreaseCriticalityBasedOnEnv = $jResp->stringOf('options.decreaseCriticalityBasedOnEnv');
$DetectionMethod = $jResp->stringOf('options.detectionMethod');
$EvaluationWindow = $jResp->IntOf('options.evaluationWindow');
$HardcodedEvaluatorType = $jResp->stringOf('options.hardcodedEvaluatorType');
$BaselineUserLocations = $jResp->stringOf('options.impossibleTravelOptions.baselineUserLocations');
$KeepAlive = $jResp->IntOf('options.keepAlive');
$MaxSignalDuration = $jResp->IntOf('options.maxSignalDuration');
$ForgetAfter = $jResp->IntOf('options.newValueOptions.forgetAfter');
$LearningDuration = $jResp->IntOf('options.newValueOptions.learningDuration');
$LearningMethod = $jResp->stringOf('options.newValueOptions.learningMethod');
$LearningThreshold = $jResp->IntOf('options.newValueOptions.learningThreshold');
$v_type = $jResp->stringOf('type');
$updateAuthorId = $jResp->stringOf('updateAuthorId');
$version = $jResp->stringOf('version');
$i = 0;
$count_i = $jResp->SizeOfArray('cases');
while ($i < $count_i) {
    $jResp->put_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->put_J($j);
        $strVal = $jResp->stringOf('cases[i].notifications[j]');
        $j = $j + 1;
    }

    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('complianceSignalOptions.defaultGroupByFields');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('complianceSignalOptions.defaultGroupByFields[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('complianceSignalOptions.userGroupByFields');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('complianceSignalOptions.userGroupByFields[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('filters');
while ($i < $count_i) {
    $jResp->put_I($i);
    $action = $jResp->stringOf('filters[i].action');
    $query = $jResp->stringOf('filters[i].query');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('options.complianceRuleOptions.regoRule.resourceTypes');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('options.complianceRuleOptions.regoRule.resourceTypes[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('queries');
while ($i < $count_i) {
    $jResp->put_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->put_J($j);
        $strVal = $jResp->stringOf('queries[i].distinctFields[j]');
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray('queries[i].groupByFields');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf('queries[i].groupByFields[j]');
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray('queries[i].metrics');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf('queries[i].metrics[j]');
        $j = $j + 1;
    }

    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('tags');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('tags[i]');
    $i = $i + 1;
}


?>

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