Perl / Datadog API Collection / Update a Cloud Workload Security Agent rule
Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "data": {
# "attributes": {
# "description": "<string>",
# "enabled": "<boolean>",
# "expression": "<string>"
# },
# "type": "agent_rule"
# }
# }
$json = chilkat::CkJsonObject->new();
$json->UpdateString("data.attributes.description","<string>");
$json->UpdateString("data.attributes.enabled","<boolean>");
$json->UpdateString("data.attributes.expression","<string>");
$json->UpdateString("data.type","agent_rule");
$http->SetRequestHeader("Content-Type","application/json");
$http->SetRequestHeader("Accept","application/json");
$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);
# resp is a HttpResponse
$resp = $http->PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
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"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$AgentConstraint = $jResp->stringOf("data.attributes.agentConstraint");
$Category = $jResp->stringOf("data.attributes.category");
$CreationAuthorUuId = $jResp->stringOf("data.attributes.creationAuthorUuId");
$CreationDate = $jResp->stringOf("data.attributes.creationDate");
$Handle = $jResp->stringOf("data.attributes.creator.handle");
$Name = $jResp->stringOf("data.attributes.creator.name");
$DefaultRule = $jResp->stringOf("data.attributes.defaultRule");
$Description = $jResp->stringOf("data.attributes.description");
$Enabled = $jResp->stringOf("data.attributes.enabled");
$Expression = $jResp->stringOf("data.attributes.expression");
$AttributesName = $jResp->stringOf("data.attributes.name");
$UpdateAuthorUuId = $jResp->stringOf("data.attributes.updateAuthorUuId");
$UpdateDate = $jResp->stringOf("data.attributes.updateDate");
$UpdatedAt = $jResp->stringOf("data.attributes.updatedAt");
$UpdaterHandle = $jResp->stringOf("data.attributes.updater.handle");
$UpdaterName = $jResp->stringOf("data.attributes.updater.name");
$Version = $jResp->stringOf("data.attributes.version");
$Id = $jResp->stringOf("data.id");
$v_Type = $jResp->stringOf("data.type");
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"description": "<string>",
"enabled": "<boolean>",
"expression": "<string>"
},
"type": "agent_rule"
}
}'
https://api.app.ddog-gov.com/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id
Postman Collection Item JSON
{
"name": "Update a Cloud Workload Security Agent rule",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"<string>\",\n \"enabled\": \"<boolean>\",\n \"expression\": \"<string>\"\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id",
"value": "<string>"
}
]
},
"description": "Update a specific Agent rule.\nReturns the Agent rule object when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"<string>\",\n \"enabled\": \"<boolean>\",\n \"expression\": \"<string>\"\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\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}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"<string>\",\n \"enabled\": \"<boolean>\",\n \"expression\": \"<string>\"\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"<string>\",\n \"enabled\": \"<boolean>\",\n \"expression\": \"<string>\"\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"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": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"<string>\",\n \"enabled\": \"<boolean>\",\n \"expression\": \"<string>\"\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_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": "Concurrent Modification",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"<string>\",\n \"enabled\": \"<boolean>\",\n \"expression\": \"<string>\"\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_rule_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_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": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"description\": \"<string>\",\n \"enabled\": \"<boolean>\",\n \"expression\": \"<string>\"\n },\n \"type\": \"agent_rule\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"security_monitoring",
"cloud_workload_security",
"agent_rules",
":agent_rule_id"
],
"variable": [
{
"key": "agent_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}"
}
]
}
