Summary
Add Device Groups to Node
Description
Add device groups to a node in a Golden Config tree
Route
POST /configuration_manager/configs/devices/groups
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| treeId |
string |
yes |
- |
| version |
string |
yes |
- |
| nodePath |
string |
yes |
- |
| deviceGroups |
array |
yes |
Device group id's to add |
Copied to Clipboard
{
"treeId": "5c35355dbebaa82eaf8113f0",
"version": "v3",
"nodePath": "base/US East",
"deviceGroups": [
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0"
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"treeId": {
"title": "treeId",
"$ref": "common#/definitions/mongoObjectId"
},
"version": {
"title": "version",
"$ref": "goldenConfigData#/definitions/goldenConfigTreeVersionName"
},
"nodePath": {
"title": "nodePath",
"$ref": "goldenConfigData#/definitions/goldenConfigNodePath"
},
"deviceGroups": {
"title": "deviceGroups",
"type": "array",
"items": {
"$ref": "common#/definitions/mongoObjectId"
}
}
},
"required": [
"treeId",
"version",
"nodePath",
"deviceGroups"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| updateNodeResult |
object |
- |
Copied to Clipboard
{
"status": "success",
"message": "Golden Config node updated"
}
Copied to Clipboard
{
"title": "updateNodeResult",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"examples": [
"Golden Config node updated"
]
}
}
}
