Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateInt("page[size]",10)
queryParams.UpdateInt("page[number]",0)
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/security_monitoring/rules",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": [
# {
# "cases": [
# {
# "condition": "<string>",
# "name": "<string>",
# "notifications": [
# "<string>",
# "<string>"
# ],
# "status": "medium"
# },
# {
# "condition": "<string>",
# "name": "<string>",
# "notifications": [
# "<string>",
# "<string>"
# ],
# "status": "info"
# }
# ],
# "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>",
# "sunt__": {}
# },
# "decreaseCriticalityBasedOnEnv": "<boolean>",
# "detectionMethod": "threshold",
# "evaluationWindow": 7200,
# "hardcodedEvaluatorType": "log4shell",
# "impossibleTravelOptions": {
# "baselineUserLocations": "<boolean>"
# },
# "keepAlive": 60,
# "maxSignalDuration": 60,
# "newValueOptions": {
# "forgetAfter": 14,
# "learningDuration": 0,
# "learningMethod": "duration",
# "learningThreshold": 0
# }
# },
# "queries": [
# {
# "aggregation": "geo_data",
# "distinctFields": [
# "<string>",
# "<string>"
# ],
# "groupByFields": [
# "<string>",
# "<string>"
# ],
# "metric": "<string>",
# "metrics": [
# "<string>",
# "<string>"
# ],
# "name": "<string>",
# "query": "<string>"
# },
# {
# "aggregation": "new_value",
# "distinctFields": [
# "<string>",
# "<string>"
# ],
# "groupByFields": [
# "<string>",
# "<string>"
# ],
# "metric": "<string>",
# "metrics": [
# "<string>",
# "<string>"
# ],
# "name": "<string>",
# "query": "<string>"
# }
# ],
# "tags": [
# "<string>",
# "<string>"
# ],
# "type": "log_detection",
# "updateAuthorId": "<long>",
# "version": "<long>"
# },
# {
# "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": "suppress",
# "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>",
# "mollit_4": {},
# "culpa_2": {}
# },
# "decreaseCriticalityBasedOnEnv": "<boolean>",
# "detectionMethod": "hardcoded",
# "evaluationWindow": 300,
# "hardcodedEvaluatorType": "log4shell",
# "impossibleTravelOptions": {
# "baselineUserLocations": "<boolean>"
# },
# "keepAlive": 21600,
# "maxSignalDuration": 10800,
# "newValueOptions": {
# "forgetAfter": 2,
# "learningDuration": 0,
# "learningMethod": "duration",
# "learningThreshold": 0
# }
# },
# "queries": [
# {
# "aggregation": "new_value",
# "distinctFields": [
# "<string>",
# "<string>"
# ],
# "groupByFields": [
# "<string>",
# "<string>"
# ],
# "metric": "<string>",
# "metrics": [
# "<string>",
# "<string>"
# ],
# "name": "<string>",
# "query": "<string>"
# },
# {
# "aggregation": "geo_data",
# "distinctFields": [
# "<string>",
# "<string>"
# ],
# "groupByFields": [
# "<string>",
# "<string>"
# ],
# "metric": "<string>",
# "metrics": [
# "<string>",
# "<string>"
# ],
# "name": "<string>",
# "query": "<string>"
# }
# ],
# "tags": [
# "<string>",
# "<string>"
# ],
# "type": "infrastructure_configuration",
# "updateAuthorId": "<long>",
# "version": "<long>"
# }
# ],
# "meta": {
# "page": {
# "total_count": "<long>",
# "total_filtered_count": "<long>"
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Total_count = jResp.stringOf("meta.page.total_count")
Total_filtered_count = jResp.stringOf("meta.page.total_filtered_count")
i = 0
count_i = jResp.SizeOfArray("data")
while i < count_i
jResp.put_I(i)
DefaultActivationStatus = jResp.stringOf("data[i].complianceSignalOptions.defaultActivationStatus")
UserActivationStatus = jResp.stringOf("data[i].complianceSignalOptions.userActivationStatus")
createdAt = jResp.stringOf("data[i].createdAt")
creationAuthorId = jResp.stringOf("data[i].creationAuthorId")
deprecationDate = jResp.stringOf("data[i].deprecationDate")
hasExtendedTitle = jResp.stringOf("data[i].hasExtendedTitle")
id = jResp.stringOf("data[i].id")
isDefault = jResp.stringOf("data[i].isDefault")
isDeleted = jResp.stringOf("data[i].isDeleted")
isEnabled = jResp.stringOf("data[i].isEnabled")
message = jResp.stringOf("data[i].message")
name = jResp.stringOf("data[i].name")
ComplexRule = jResp.stringOf("data[i].options.complianceRuleOptions.complexRule")
Policy = jResp.stringOf("data[i].options.complianceRuleOptions.regoRule.policy")
ResourceType = jResp.stringOf("data[i].options.complianceRuleOptions.resourceType")
DecreaseCriticalityBasedOnEnv = jResp.stringOf("data[i].options.decreaseCriticalityBasedOnEnv")
DetectionMethod = jResp.stringOf("data[i].options.detectionMethod")
EvaluationWindow = jResp.IntOf("data[i].options.evaluationWindow")
HardcodedEvaluatorType = jResp.stringOf("data[i].options.hardcodedEvaluatorType")
BaselineUserLocations = jResp.stringOf("data[i].options.impossibleTravelOptions.baselineUserLocations")
KeepAlive = jResp.IntOf("data[i].options.keepAlive")
MaxSignalDuration = jResp.IntOf("data[i].options.maxSignalDuration")
ForgetAfter = jResp.IntOf("data[i].options.newValueOptions.forgetAfter")
LearningDuration = jResp.IntOf("data[i].options.newValueOptions.learningDuration")
LearningMethod = jResp.stringOf("data[i].options.newValueOptions.learningMethod")
LearningThreshold = jResp.IntOf("data[i].options.newValueOptions.learningThreshold")
v_type = jResp.stringOf("data[i].type")
updateAuthorId = jResp.stringOf("data[i].updateAuthorId")
version = jResp.stringOf("data[i].version")
j = 0
count_j = jResp.SizeOfArray("data[i].cases")
while j < count_j
jResp.put_J(j)
condition = jResp.stringOf("data[i].cases[j].condition")
name = jResp.stringOf("data[i].cases[j].name")
status = jResp.stringOf("data[i].cases[j].status")
k = 0
count_k = jResp.SizeOfArray("data[i].cases[j].notifications")
while k < count_k
jResp.put_K(k)
strVal = jResp.stringOf("data[i].cases[j].notifications[k]")
k = k + 1
end
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("data[i].complianceSignalOptions.defaultGroupByFields")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("data[i].complianceSignalOptions.defaultGroupByFields[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("data[i].complianceSignalOptions.userGroupByFields")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("data[i].complianceSignalOptions.userGroupByFields[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("data[i].filters")
while j < count_j
jResp.put_J(j)
action = jResp.stringOf("data[i].filters[j].action")
query = jResp.stringOf("data[i].filters[j].query")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("data[i].options.complianceRuleOptions.regoRule.resourceTypes")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("data[i].options.complianceRuleOptions.regoRule.resourceTypes[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("data[i].queries")
while j < count_j
jResp.put_J(j)
aggregation = jResp.stringOf("data[i].queries[j].aggregation")
metric = jResp.stringOf("data[i].queries[j].metric")
name = jResp.stringOf("data[i].queries[j].name")
query = jResp.stringOf("data[i].queries[j].query")
k = 0
count_k = jResp.SizeOfArray("data[i].queries[j].distinctFields")
while k < count_k
jResp.put_K(k)
strVal = jResp.stringOf("data[i].queries[j].distinctFields[k]")
k = k + 1
end
k = 0
count_k = jResp.SizeOfArray("data[i].queries[j].groupByFields")
while k < count_k
jResp.put_K(k)
strVal = jResp.stringOf("data[i].queries[j].groupByFields[k]")
k = k + 1
end
k = 0
count_k = jResp.SizeOfArray("data[i].queries[j].metrics")
while k < count_k
jResp.put_K(k)
strVal = jResp.stringOf("data[i].queries[j].metrics[k]")
k = k + 1
end
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("data[i].tags")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("data[i].tags[j]")
j = j + 1
end
i = i + 1
end
Curl Command
curl -G -d "page[size]=10"
-d "page[number]=0"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/security_monitoring/rules
Postman Collection Item JSON
{
"name": "List rules",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/rules?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
]
},
"description": "List 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/rules?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\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\": \"info\"\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 \"sunt__\": {}\n },\n \"decreaseCriticalityBasedOnEnv\": \"<boolean>\",\n \"detectionMethod\": \"threshold\",\n \"evaluationWindow\": 7200,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": \"<boolean>\"\n },\n \"keepAlive\": 60,\n \"maxSignalDuration\": 60,\n \"newValueOptions\": {\n \"forgetAfter\": 14,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"geo_data\",\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\": \"new_value\",\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\": \"log_detection\",\n \"updateAuthorId\": \"<long>\",\n \"version\": \"<long>\"\n },\n {\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\": \"suppress\",\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 \"mollit_4\": {},\n \"culpa_2\": {}\n },\n \"decreaseCriticalityBasedOnEnv\": \"<boolean>\",\n \"detectionMethod\": \"hardcoded\",\n \"evaluationWindow\": 300,\n \"hardcodedEvaluatorType\": \"log4shell\",\n \"impossibleTravelOptions\": {\n \"baselineUserLocations\": \"<boolean>\"\n },\n \"keepAlive\": 21600,\n \"maxSignalDuration\": 10800,\n \"newValueOptions\": {\n \"forgetAfter\": 2,\n \"learningDuration\": 0,\n \"learningMethod\": \"duration\",\n \"learningThreshold\": 0\n }\n },\n \"queries\": [\n {\n \"aggregation\": \"new_value\",\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\": \"geo_data\",\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\": \"infrastructure_configuration\",\n \"updateAuthorId\": \"<long>\",\n \"version\": \"<long>\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": \"<long>\",\n \"total_filtered_count\": \"<long>\"\n }\n }\n}"
},
{
"name": "Bad Request",
"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?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_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?page[size]=10&page[number]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"rules"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
}
]
}
},
"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}"
}
]
}
