TCL / Datadog API Collection / Get all Cloud Workload Security Agent rules
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api.app.ddog-gov.com/api/v2/security_monitoring/cloud_workload_security/agent_rules" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": [
# {
# "attributes": {
# "agentConstraint": "<string>",
# "category": "<string>",
# "creationAuthorUuId": "<string>",
# "creationDate": "<long>",
# "creator": {
# "handle": "<string>",
# "name": "<string>"
# },
# "defaultRule": "<boolean>",
# "description": "<string>",
# "enabled": "<boolean>",
# "expression": "<string>",
# "name": "<string>",
# "updateAuthorUuId": "<string>",
# "updateDate": "<long>",
# "updatedAt": "<long>",
# "updater": {
# "handle": "<string>",
# "name": "<string>"
# },
# "version": "<long>"
# },
# "id": "<string>",
# "type": "agent_rule"
# },
# {
# "attributes": {
# "agentConstraint": "<string>",
# "category": "<string>",
# "creationAuthorUuId": "<string>",
# "creationDate": "<long>",
# "creator": {
# "handle": "<string>",
# "name": "<string>"
# },
# "defaultRule": "<boolean>",
# "description": "<string>",
# "enabled": "<boolean>",
# "expression": "<string>",
# "name": "<string>",
# "updateAuthorUuId": "<string>",
# "updateDate": "<long>",
# "updatedAt": "<long>",
# "updater": {
# "handle": "<string>",
# "name": "<string>"
# },
# "version": "<long>"
# },
# "id": "<string>",
# "type": "agent_rule"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set AgentConstraint [CkJsonObject_stringOf $jResp "data[i].attributes.agentConstraint"]
set Category [CkJsonObject_stringOf $jResp "data[i].attributes.category"]
set CreationAuthorUuId [CkJsonObject_stringOf $jResp "data[i].attributes.creationAuthorUuId"]
set CreationDate [CkJsonObject_stringOf $jResp "data[i].attributes.creationDate"]
set Handle [CkJsonObject_stringOf $jResp "data[i].attributes.creator.handle"]
set Name [CkJsonObject_stringOf $jResp "data[i].attributes.creator.name"]
set DefaultRule [CkJsonObject_stringOf $jResp "data[i].attributes.defaultRule"]
set Description [CkJsonObject_stringOf $jResp "data[i].attributes.description"]
set Enabled [CkJsonObject_stringOf $jResp "data[i].attributes.enabled"]
set Expression [CkJsonObject_stringOf $jResp "data[i].attributes.expression"]
set attributesName [CkJsonObject_stringOf $jResp "data[i].attributes.name"]
set UpdateAuthorUuId [CkJsonObject_stringOf $jResp "data[i].attributes.updateAuthorUuId"]
set UpdateDate [CkJsonObject_stringOf $jResp "data[i].attributes.updateDate"]
set UpdatedAt [CkJsonObject_stringOf $jResp "data[i].attributes.updatedAt"]
set UpdaterHandle [CkJsonObject_stringOf $jResp "data[i].attributes.updater.handle"]
set UpdaterName [CkJsonObject_stringOf $jResp "data[i].attributes.updater.name"]
set Version [CkJsonObject_stringOf $jResp "data[i].attributes.version"]
set id [CkJsonObject_stringOf $jResp "data[i].id"]
set v_type [CkJsonObject_stringOf $jResp "data[i].type"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/security_monitoring/cloud_workload_security/agent_rules
Postman Collection Item JSON
{
"name": "Get all Cloud Workload Security Agent rules",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
},
"description": "Get the list of Agent 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/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"agentConstraint\": \"<string>\",\n \"category\": \"<string>\",\n \"creationAuthorUuId\": \"<string>\",\n \"creationDate\": \"<long>\",\n \"creator\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"defaultRule\": \"<boolean>\",\n \"description\": \"<string>\",\n \"enabled\": \"<boolean>\",\n \"expression\": \"<string>\",\n \"name\": \"<string>\",\n \"updateAuthorUuId\": \"<string>\",\n \"updateDate\": \"<long>\",\n \"updatedAt\": \"<long>\",\n \"updater\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"version\": \"<long>\"\n },\n \"id\": \"<string>\",\n \"type\": \"agent_rule\"\n },\n {\n \"attributes\": {\n \"agentConstraint\": \"<string>\",\n \"category\": \"<string>\",\n \"creationAuthorUuId\": \"<string>\",\n \"creationDate\": \"<long>\",\n \"creator\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"defaultRule\": \"<boolean>\",\n \"description\": \"<string>\",\n \"enabled\": \"<boolean>\",\n \"expression\": \"<string>\",\n \"name\": \"<string>\",\n \"updateAuthorUuId\": \"<string>\",\n \"updateDate\": \"<long>\",\n \"updatedAt\": \"<long>\",\n \"updater\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"version\": \"<long>\"\n },\n \"id\": \"<string>\",\n \"type\": \"agent_rule\"\n }\n ]\n}"
},
{
"name": "Not Authorized",
"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/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
}
},
"status": "Forbidden",
"code": 403,
"_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/cloud_workload_security/agent_rules",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules"
]
}
},
"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}"
}
]
}
