Summary
Adds node(s) to a compliance plan
Description
Adds new node(s) to an already existing compliance plan
Route
POST /configuration_manager/compliance_plans/nodes
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
planId |
string |
yes |
Object ID of the Compliance Plan |
nodes |
array |
yes |
An array of nodes to add into the compliance plan. |
options |
object |
no |
Additional Options. Note: None currently supported |
Copied to Clipboard
{
"planId": "5c35355dbebaa82eaf8113f0",
"nodes": [
{
"treeId": "exercitation voluptate velit laborum dolore",
"version": "velit nisi et laboris",
"nodeId": "tempor",
"devices": [
"xr9kv-atl"
],
"deviceGroups": [
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0"
],
"tasks": [
"5c35355dbebaa82eaf8113f0"
]
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"planId": {
"title": "planId",
"$ref": "common#/definitions/mongoObjectId"
},
"nodes": {
"title": "nodes",
"type": "array",
"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"
}
}
}
}
},
"options": {
"title": "options",
"type": "object",
"properties": {}
}
},
"required": [
"planId",
"nodes"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
updateResult |
object |
- |
Copied to Clipboard
{
"status": "success",
"message": "Successfully added node(s) to compliance plan"
}
Copied to Clipboard
{
"title": "updateResult",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"examples": [
"Successfully added node(s) to compliance plan"
]
}
}
}