DataFlex / Datadog API Collection / Get a Cloud Workload Security Agent rule
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAgentConstraint
String sCategory
String sCreationAuthorUuId
String sCreationDate
String sHandle
String sName
String sDefaultRule
String sDescription
String sEnabled
String sExpression
String sAttributesName
String sUpdateAuthorUuId
String sUpdateDate
String sUpdatedAt
String sUpdaterHandle
String sUpdaterName
String sVersion
String sId
String sV_Type
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://api.app.ddog-gov.com/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
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"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "data.attributes.agentConstraint" To sAgentConstraint
Get ComStringOf Of hoJResp "data.attributes.category" To sCategory
Get ComStringOf Of hoJResp "data.attributes.creationAuthorUuId" To sCreationAuthorUuId
Get ComStringOf Of hoJResp "data.attributes.creationDate" To sCreationDate
Get ComStringOf Of hoJResp "data.attributes.creator.handle" To sHandle
Get ComStringOf Of hoJResp "data.attributes.creator.name" To sName
Get ComStringOf Of hoJResp "data.attributes.defaultRule" To sDefaultRule
Get ComStringOf Of hoJResp "data.attributes.description" To sDescription
Get ComStringOf Of hoJResp "data.attributes.enabled" To sEnabled
Get ComStringOf Of hoJResp "data.attributes.expression" To sExpression
Get ComStringOf Of hoJResp "data.attributes.name" To sAttributesName
Get ComStringOf Of hoJResp "data.attributes.updateAuthorUuId" To sUpdateAuthorUuId
Get ComStringOf Of hoJResp "data.attributes.updateDate" To sUpdateDate
Get ComStringOf Of hoJResp "data.attributes.updatedAt" To sUpdatedAt
Get ComStringOf Of hoJResp "data.attributes.updater.handle" To sUpdaterHandle
Get ComStringOf Of hoJResp "data.attributes.updater.name" To sUpdaterName
Get ComStringOf Of hoJResp "data.attributes.version" To sVersion
Get ComStringOf Of hoJResp "data.id" To sId
Get ComStringOf Of hoJResp "data.type" To sV_Type
End_Procedure
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/security_monitoring/cloud_workload_security/agent_rules/:agent_rule_id
Postman Collection Item JSON
{
"name": "Get a Cloud Workload Security Agent rule",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/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": "Get the details of a specific Agent rule."
},
"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/: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": "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/: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": "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/: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": "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/: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}"
}
]
}
