Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
condition: PWideChar;
status: PWideChar;
j: Integer;
count_j: Integer;
strVal: PWideChar;
action: PWideChar;
query: PWideChar;
aggregation: PWideChar;
metric: PWideChar;
DefaultActivationStatus: PWideChar;
UserActivationStatus: PWideChar;
createdAt: PWideChar;
creationAuthorId: PWideChar;
deprecationDate: PWideChar;
hasExtendedTitle: PWideChar;
id: PWideChar;
isDefault: PWideChar;
isDeleted: PWideChar;
isEnabled: PWideChar;
message: PWideChar;
name: PWideChar;
ComplexRule: PWideChar;
Policy: PWideChar;
ResourceType: PWideChar;
DecreaseCriticalityBasedOnEnv: PWideChar;
DetectionMethod: PWideChar;
EvaluationWindow: Integer;
HardcodedEvaluatorType: PWideChar;
BaselineUserLocations: PWideChar;
KeepAlive: Integer;
MaxSignalDuration: Integer;
ForgetAfter: Integer;
LearningDuration: Integer;
LearningMethod: PWideChar;
LearningThreshold: Integer;
v_type: PWideChar;
updateAuthorId: PWideChar;
version: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_SetRequestHeader(http,'Accept','application/json');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.app.ddog-gov.com/api/v2/security_monitoring/rules/:rule_id',sbResponseBody);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttp__lastHeader(http));
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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 := CkJsonObject__stringOf(jResp,'complianceSignalOptions.defaultActivationStatus');
UserActivationStatus := CkJsonObject__stringOf(jResp,'complianceSignalOptions.userActivationStatus');
createdAt := CkJsonObject__stringOf(jResp,'createdAt');
creationAuthorId := CkJsonObject__stringOf(jResp,'creationAuthorId');
deprecationDate := CkJsonObject__stringOf(jResp,'deprecationDate');
hasExtendedTitle := CkJsonObject__stringOf(jResp,'hasExtendedTitle');
id := CkJsonObject__stringOf(jResp,'id');
isDefault := CkJsonObject__stringOf(jResp,'isDefault');
isDeleted := CkJsonObject__stringOf(jResp,'isDeleted');
isEnabled := CkJsonObject__stringOf(jResp,'isEnabled');
message := CkJsonObject__stringOf(jResp,'message');
name := CkJsonObject__stringOf(jResp,'name');
ComplexRule := CkJsonObject__stringOf(jResp,'options.complianceRuleOptions.complexRule');
Policy := CkJsonObject__stringOf(jResp,'options.complianceRuleOptions.regoRule.policy');
ResourceType := CkJsonObject__stringOf(jResp,'options.complianceRuleOptions.resourceType');
DecreaseCriticalityBasedOnEnv := CkJsonObject__stringOf(jResp,'options.decreaseCriticalityBasedOnEnv');
DetectionMethod := CkJsonObject__stringOf(jResp,'options.detectionMethod');
EvaluationWindow := CkJsonObject_IntOf(jResp,'options.evaluationWindow');
HardcodedEvaluatorType := CkJsonObject__stringOf(jResp,'options.hardcodedEvaluatorType');
BaselineUserLocations := CkJsonObject__stringOf(jResp,'options.impossibleTravelOptions.baselineUserLocations');
KeepAlive := CkJsonObject_IntOf(jResp,'options.keepAlive');
MaxSignalDuration := CkJsonObject_IntOf(jResp,'options.maxSignalDuration');
ForgetAfter := CkJsonObject_IntOf(jResp,'options.newValueOptions.forgetAfter');
LearningDuration := CkJsonObject_IntOf(jResp,'options.newValueOptions.learningDuration');
LearningMethod := CkJsonObject__stringOf(jResp,'options.newValueOptions.learningMethod');
LearningThreshold := CkJsonObject_IntOf(jResp,'options.newValueOptions.learningThreshold');
v_type := CkJsonObject__stringOf(jResp,'type');
updateAuthorId := CkJsonObject__stringOf(jResp,'updateAuthorId');
version := CkJsonObject__stringOf(jResp,'version');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'cases');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
condition := CkJsonObject__stringOf(jResp,'cases[i].condition');
name := CkJsonObject__stringOf(jResp,'cases[i].name');
status := CkJsonObject__stringOf(jResp,'cases[i].status');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'cases[i].notifications');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
strVal := CkJsonObject__stringOf(jResp,'cases[i].notifications[j]');
j := j + 1;
end;
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'complianceSignalOptions.defaultGroupByFields');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'complianceSignalOptions.defaultGroupByFields[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'complianceSignalOptions.userGroupByFields');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'complianceSignalOptions.userGroupByFields[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'filters');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
action := CkJsonObject__stringOf(jResp,'filters[i].action');
query := CkJsonObject__stringOf(jResp,'filters[i].query');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'options.complianceRuleOptions.regoRule.resourceTypes');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'options.complianceRuleOptions.regoRule.resourceTypes[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'queries');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
aggregation := CkJsonObject__stringOf(jResp,'queries[i].aggregation');
metric := CkJsonObject__stringOf(jResp,'queries[i].metric');
name := CkJsonObject__stringOf(jResp,'queries[i].name');
query := CkJsonObject__stringOf(jResp,'queries[i].query');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'queries[i].distinctFields');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
strVal := CkJsonObject__stringOf(jResp,'queries[i].distinctFields[j]');
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'queries[i].groupByFields');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
strVal := CkJsonObject__stringOf(jResp,'queries[i].groupByFields[j]');
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'queries[i].metrics');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
strVal := CkJsonObject__stringOf(jResp,'queries[i].metrics[j]');
j := j + 1;
end;
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'tags');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'tags[i]');
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
