Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
http.SetRequestHeader("Accept","application/json");
var sbResponseBody = new chilkat.StringBuilder();
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/security_monitoring/rules/:rule_id",sbResponseBody);
if (success == false) {
console.log(http.LastErrorText);
return;
}
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = http.LastStatus;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(http.LastHeader);
console.log("Failed.");
return;
}
// 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
var condition;
var status;
var j;
var count_j;
var strVal;
var action;
var query;
var aggregation;
var metric;
var DefaultActivationStatus = jResp.StringOf("complianceSignalOptions.defaultActivationStatus");
var UserActivationStatus = jResp.StringOf("complianceSignalOptions.userActivationStatus");
var createdAt = jResp.StringOf("createdAt");
var creationAuthorId = jResp.StringOf("creationAuthorId");
var deprecationDate = jResp.StringOf("deprecationDate");
var hasExtendedTitle = jResp.StringOf("hasExtendedTitle");
var id = jResp.StringOf("id");
var isDefault = jResp.StringOf("isDefault");
var isDeleted = jResp.StringOf("isDeleted");
var isEnabled = jResp.StringOf("isEnabled");
var message = jResp.StringOf("message");
var name = jResp.StringOf("name");
var ComplexRule = jResp.StringOf("options.complianceRuleOptions.complexRule");
var Policy = jResp.StringOf("options.complianceRuleOptions.regoRule.policy");
var ResourceType = jResp.StringOf("options.complianceRuleOptions.resourceType");
var DecreaseCriticalityBasedOnEnv = jResp.StringOf("options.decreaseCriticalityBasedOnEnv");
var DetectionMethod = jResp.StringOf("options.detectionMethod");
var EvaluationWindow = jResp.IntOf("options.evaluationWindow");
var HardcodedEvaluatorType = jResp.StringOf("options.hardcodedEvaluatorType");
var BaselineUserLocations = jResp.StringOf("options.impossibleTravelOptions.baselineUserLocations");
var KeepAlive = jResp.IntOf("options.keepAlive");
var MaxSignalDuration = jResp.IntOf("options.maxSignalDuration");
var ForgetAfter = jResp.IntOf("options.newValueOptions.forgetAfter");
var LearningDuration = jResp.IntOf("options.newValueOptions.learningDuration");
var LearningMethod = jResp.StringOf("options.newValueOptions.learningMethod");
var LearningThreshold = jResp.IntOf("options.newValueOptions.learningThreshold");
var v_type = jResp.StringOf("type");
var updateAuthorId = jResp.StringOf("updateAuthorId");
var version = jResp.StringOf("version");
var i = 0;
var 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;
}
i = i+1;
}
i = 0;
count_i = jResp.SizeOfArray("complianceSignalOptions.defaultGroupByFields");
while (i < count_i) {
jResp.I = i;
strVal = jResp.StringOf("complianceSignalOptions.defaultGroupByFields[i]");
i = i+1;
}
i = 0;
count_i = jResp.SizeOfArray("complianceSignalOptions.userGroupByFields");
while (i < count_i) {
jResp.I = i;
strVal = jResp.StringOf("complianceSignalOptions.userGroupByFields[i]");
i = i+1;
}
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;
}
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;
}
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;
}
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;
}
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;
}
i = i+1;
}
i = 0;
count_i = jResp.SizeOfArray("tags");
while (i < count_i) {
jResp.I = i;
strVal = jResp.StringOf("tags[i]");
i = i+1;
}
}
chilkatExample();
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}"
}
]
}
