Ruby / Datadog API Collection / Get all Cloud Workload Security Agent rules
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()
http.SetRequestHeader("Accept","application/json")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v2/security_monitoring/cloud_workload_security/agent_rules",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
end
# 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
i = 0
count_i = jResp.SizeOfArray("data")
while i < count_i
jResp.put_I(i)
AgentConstraint = jResp.stringOf("data[i].attributes.agentConstraint")
Category = jResp.stringOf("data[i].attributes.category")
CreationAuthorUuId = jResp.stringOf("data[i].attributes.creationAuthorUuId")
CreationDate = jResp.stringOf("data[i].attributes.creationDate")
Handle = jResp.stringOf("data[i].attributes.creator.handle")
Name = jResp.stringOf("data[i].attributes.creator.name")
DefaultRule = jResp.stringOf("data[i].attributes.defaultRule")
Description = jResp.stringOf("data[i].attributes.description")
Enabled = jResp.stringOf("data[i].attributes.enabled")
Expression = jResp.stringOf("data[i].attributes.expression")
attributesName = jResp.stringOf("data[i].attributes.name")
UpdateAuthorUuId = jResp.stringOf("data[i].attributes.updateAuthorUuId")
UpdateDate = jResp.stringOf("data[i].attributes.updateDate")
UpdatedAt = jResp.stringOf("data[i].attributes.updatedAt")
UpdaterHandle = jResp.stringOf("data[i].attributes.updater.handle")
UpdaterName = jResp.stringOf("data[i].attributes.updater.name")
Version = jResp.stringOf("data[i].attributes.version")
id = jResp.stringOf("data[i].id")
v_type = jResp.stringOf("data[i].type")
i = i + 1
end
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}"
}
]
}
