Back to Collection Items
#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
http.SetRequestHeader(L"Accept",L"application/json");
CkStringBuilderW sbResponseBody;
success = http.QuickGetSb(L"https://api.app.ddog-gov.com/api/v2/security_monitoring/rules/:rule_id",sbResponseBody);
if (success == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = http.get_LastStatus();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",http.lastHeader());
wprintf(L"Failed.\n");
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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
const wchar_t *condition = 0;
const wchar_t *status = 0;
int j;
int count_j;
const wchar_t *strVal = 0;
const wchar_t *action = 0;
const wchar_t *query = 0;
const wchar_t *aggregation = 0;
const wchar_t *metric = 0;
const wchar_t *DefaultActivationStatus = jResp.stringOf(L"complianceSignalOptions.defaultActivationStatus");
const wchar_t *UserActivationStatus = jResp.stringOf(L"complianceSignalOptions.userActivationStatus");
const wchar_t *createdAt = jResp.stringOf(L"createdAt");
const wchar_t *creationAuthorId = jResp.stringOf(L"creationAuthorId");
const wchar_t *deprecationDate = jResp.stringOf(L"deprecationDate");
const wchar_t *hasExtendedTitle = jResp.stringOf(L"hasExtendedTitle");
const wchar_t *id = jResp.stringOf(L"id");
const wchar_t *isDefault = jResp.stringOf(L"isDefault");
const wchar_t *isDeleted = jResp.stringOf(L"isDeleted");
const wchar_t *isEnabled = jResp.stringOf(L"isEnabled");
const wchar_t *message = jResp.stringOf(L"message");
const wchar_t *name = jResp.stringOf(L"name");
const wchar_t *ComplexRule = jResp.stringOf(L"options.complianceRuleOptions.complexRule");
const wchar_t *Policy = jResp.stringOf(L"options.complianceRuleOptions.regoRule.policy");
const wchar_t *ResourceType = jResp.stringOf(L"options.complianceRuleOptions.resourceType");
const wchar_t *DecreaseCriticalityBasedOnEnv = jResp.stringOf(L"options.decreaseCriticalityBasedOnEnv");
const wchar_t *DetectionMethod = jResp.stringOf(L"options.detectionMethod");
int EvaluationWindow = jResp.IntOf(L"options.evaluationWindow");
const wchar_t *HardcodedEvaluatorType = jResp.stringOf(L"options.hardcodedEvaluatorType");
const wchar_t *BaselineUserLocations = jResp.stringOf(L"options.impossibleTravelOptions.baselineUserLocations");
int KeepAlive = jResp.IntOf(L"options.keepAlive");
int MaxSignalDuration = jResp.IntOf(L"options.maxSignalDuration");
int ForgetAfter = jResp.IntOf(L"options.newValueOptions.forgetAfter");
int LearningDuration = jResp.IntOf(L"options.newValueOptions.learningDuration");
const wchar_t *LearningMethod = jResp.stringOf(L"options.newValueOptions.learningMethod");
int LearningThreshold = jResp.IntOf(L"options.newValueOptions.learningThreshold");
const wchar_t *v_type = jResp.stringOf(L"type");
const wchar_t *updateAuthorId = jResp.stringOf(L"updateAuthorId");
const wchar_t *version = jResp.stringOf(L"version");
int i = 0;
int count_i = jResp.SizeOfArray(L"cases");
while (i < count_i) {
jResp.put_I(i);
condition = jResp.stringOf(L"cases[i].condition");
name = jResp.stringOf(L"cases[i].name");
status = jResp.stringOf(L"cases[i].status");
j = 0;
count_j = jResp.SizeOfArray(L"cases[i].notifications");
while (j < count_j) {
jResp.put_J(j);
strVal = jResp.stringOf(L"cases[i].notifications[j]");
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray(L"complianceSignalOptions.defaultGroupByFields");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf(L"complianceSignalOptions.defaultGroupByFields[i]");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray(L"complianceSignalOptions.userGroupByFields");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf(L"complianceSignalOptions.userGroupByFields[i]");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray(L"filters");
while (i < count_i) {
jResp.put_I(i);
action = jResp.stringOf(L"filters[i].action");
query = jResp.stringOf(L"filters[i].query");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray(L"options.complianceRuleOptions.regoRule.resourceTypes");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf(L"options.complianceRuleOptions.regoRule.resourceTypes[i]");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray(L"queries");
while (i < count_i) {
jResp.put_I(i);
aggregation = jResp.stringOf(L"queries[i].aggregation");
metric = jResp.stringOf(L"queries[i].metric");
name = jResp.stringOf(L"queries[i].name");
query = jResp.stringOf(L"queries[i].query");
j = 0;
count_j = jResp.SizeOfArray(L"queries[i].distinctFields");
while (j < count_j) {
jResp.put_J(j);
strVal = jResp.stringOf(L"queries[i].distinctFields[j]");
j = j + 1;
}
j = 0;
count_j = jResp.SizeOfArray(L"queries[i].groupByFields");
while (j < count_j) {
jResp.put_J(j);
strVal = jResp.stringOf(L"queries[i].groupByFields[j]");
j = j + 1;
}
j = 0;
count_j = jResp.SizeOfArray(L"queries[i].metrics");
while (j < count_j) {
jResp.put_J(j);
strVal = jResp.stringOf(L"queries[i].metrics[j]");
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray(L"tags");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf(L"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}"
}
]
}