Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.app.ddog-gov.com/api/v2/security_monitoring/rules/:rule_id",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
condition.s
status.s
j.i
count_j.i
strVal.s
action.s
query.s
aggregation.s
metric.s
DefaultActivationStatus.s = CkJsonObject::ckStringOf(jResp,"complianceSignalOptions.defaultActivationStatus")
UserActivationStatus.s = CkJsonObject::ckStringOf(jResp,"complianceSignalOptions.userActivationStatus")
createdAt.s = CkJsonObject::ckStringOf(jResp,"createdAt")
creationAuthorId.s = CkJsonObject::ckStringOf(jResp,"creationAuthorId")
deprecationDate.s = CkJsonObject::ckStringOf(jResp,"deprecationDate")
hasExtendedTitle.s = CkJsonObject::ckStringOf(jResp,"hasExtendedTitle")
id.s = CkJsonObject::ckStringOf(jResp,"id")
isDefault.s = CkJsonObject::ckStringOf(jResp,"isDefault")
isDeleted.s = CkJsonObject::ckStringOf(jResp,"isDeleted")
isEnabled.s = CkJsonObject::ckStringOf(jResp,"isEnabled")
message.s = CkJsonObject::ckStringOf(jResp,"message")
name.s = CkJsonObject::ckStringOf(jResp,"name")
ComplexRule.s = CkJsonObject::ckStringOf(jResp,"options.complianceRuleOptions.complexRule")
Policy.s = CkJsonObject::ckStringOf(jResp,"options.complianceRuleOptions.regoRule.policy")
ResourceType.s = CkJsonObject::ckStringOf(jResp,"options.complianceRuleOptions.resourceType")
DecreaseCriticalityBasedOnEnv.s = CkJsonObject::ckStringOf(jResp,"options.decreaseCriticalityBasedOnEnv")
DetectionMethod.s = CkJsonObject::ckStringOf(jResp,"options.detectionMethod")
EvaluationWindow.i = CkJsonObject::ckIntOf(jResp,"options.evaluationWindow")
HardcodedEvaluatorType.s = CkJsonObject::ckStringOf(jResp,"options.hardcodedEvaluatorType")
BaselineUserLocations.s = CkJsonObject::ckStringOf(jResp,"options.impossibleTravelOptions.baselineUserLocations")
KeepAlive.i = CkJsonObject::ckIntOf(jResp,"options.keepAlive")
MaxSignalDuration.i = CkJsonObject::ckIntOf(jResp,"options.maxSignalDuration")
ForgetAfter.i = CkJsonObject::ckIntOf(jResp,"options.newValueOptions.forgetAfter")
LearningDuration.i = CkJsonObject::ckIntOf(jResp,"options.newValueOptions.learningDuration")
LearningMethod.s = CkJsonObject::ckStringOf(jResp,"options.newValueOptions.learningMethod")
LearningThreshold.i = CkJsonObject::ckIntOf(jResp,"options.newValueOptions.learningThreshold")
v_type.s = CkJsonObject::ckStringOf(jResp,"type")
updateAuthorId.s = CkJsonObject::ckStringOf(jResp,"updateAuthorId")
version.s = CkJsonObject::ckStringOf(jResp,"version")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"cases")
While i < count_i
CkJsonObject::setCkI(jResp, i)
condition = CkJsonObject::ckStringOf(jResp,"cases[i].condition")
name = CkJsonObject::ckStringOf(jResp,"cases[i].name")
status = CkJsonObject::ckStringOf(jResp,"cases[i].status")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"cases[i].notifications")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"cases[i].notifications[j]")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"complianceSignalOptions.defaultGroupByFields")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"complianceSignalOptions.defaultGroupByFields[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"complianceSignalOptions.userGroupByFields")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"complianceSignalOptions.userGroupByFields[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"filters")
While i < count_i
CkJsonObject::setCkI(jResp, i)
action = CkJsonObject::ckStringOf(jResp,"filters[i].action")
query = CkJsonObject::ckStringOf(jResp,"filters[i].query")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"options.complianceRuleOptions.regoRule.resourceTypes")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"options.complianceRuleOptions.regoRule.resourceTypes[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"queries")
While i < count_i
CkJsonObject::setCkI(jResp, i)
aggregation = CkJsonObject::ckStringOf(jResp,"queries[i].aggregation")
metric = CkJsonObject::ckStringOf(jResp,"queries[i].metric")
name = CkJsonObject::ckStringOf(jResp,"queries[i].name")
query = CkJsonObject::ckStringOf(jResp,"queries[i].query")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"queries[i].distinctFields")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"queries[i].distinctFields[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"queries[i].groupByFields")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"queries[i].groupByFields[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"queries[i].metrics")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"queries[i].metrics[j]")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"tags[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
