Summary
Creates a compliance plan
Description
Creates a compliance plan which can be used to execute compliance reports
Route
POST /configuration_manager/compliance_plans
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
name |
string |
yes |
Name of the new Compliance Plan |
options |
object |
no |
Additional Options. |
Copied to Clipboard
{
"name": "Firewall Policies",
"options": {
"description": "A compliance plan for firewall configs.",
"nodes": [
{
"treeId": "elit Duis commodo",
"version": "deserunt enim",
"nodeId": "dolor qui id consequat eiusmod",
"devices": [
"xr9kv-atl",
"xr9kv-atl"
],
"deviceGroups": [
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0"
],
"tasks": [
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0"
]
}
]
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string",
"examples": [
"Firewall Policies"
]
},
"options": {
"title": "options",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of the compliance plan.",
"examples": [
"A compliance plan for firewall configs."
]
},
"nodes": {
"type": "array",
"description": "Nodes to add into the compliance plan.",
"items": {
"type": "object",
"properties": {
"treeId": {
"type": "string",
"description": "The treeId of the GC that the node belongs to."
},
"version": {
"type": "string",
"description": "The version of the GC tree that the node belongs to."
},
"nodeId": {
"type": "string",
"description": "The configId of the node."
},
"variables": {
"type": "object",
"example": "{ \"ipAddress\": \"1.2.3.4\" }"
},
"devices": {
"type": "array",
"items": {
"$ref": "deviceData#/definitions/deviceName"
}
},
"deviceGroups": {
"type": "array",
"items": {
"$ref": "common#/definitions/mongoObjectId"
}
},
"tasks": {
"type": "array",
"items": {
"$ref": "common#/definitions/mongoObjectId"
}
}
}
}
}
}
}
},
"required": [
"name"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
compliancePlan |
object |
Details of the newly created compliance plan |
Copied to Clipboard
{
"title": "compliancePlan",
"type": "object",
"properties": {}
}