Summary
Run Compliance Reports.
Description
Kick off one or more compliance checks for devices in a specified Golden Config tree.
Route
POST /configuration_manager/compliance_reports
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| options |
object |
yes |
- |
Copied to Clipboard
{
"options": {
"treeId": "5c35355dbebaa82eaf8113f0",
"version": "v3",
"nodePath": "base/US East/Atlanta",
"devices": [
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl"
],
"tasks": "5f7b4c5ab2f4e0690520eed2",
"variables": [
{
"name": "variable name",
"type": "regex",
"value": "variable value"
}
],
"bidirectional": true
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"title": "options",
"type": "object",
"properties": {
"treeId": {
"$ref": "common#/definitions/mongoObjectId"
},
"version": {
"type": "string",
"examples": [
"v3"
]
},
"nodePath": {
"type": "string",
"examples": [
"base/US East/Atlanta"
]
},
"devices": {
"type": "array",
"items": {
"$ref": "deviceData#/definitions/deviceName"
}
},
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
"5f7b4c5ab2f4e0690520eed2"
]
},
"variables": {
"$ref": "goldenConfigData#/definitions/goldenConfigVariables"
},
"bidirectional": {
"type": "boolean"
}
},
"required": [
"treeId",
"version"
]
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| runComplianceBatchResult |
object |
- |
Copied to Clipboard
{
"status": 202,
"message": "compliance batch ${batchId} started",
"batchId": "5c35355dbebaa82eaf8113f0"
}
Copied to Clipboard
{
"title": "runComplianceBatchResult",
"type": "object",
"properties": {
"status": {
"type": "integer",
"const": 202
},
"message": {
"type": "string",
"examples": [
"compliance batch ${batchId} started"
]
},
"batchId": {
"$ref": "common#/definitions/mongoObjectId"
}
}
}
