Summary
Update properties of a node in a Golden Config tree.
Description
Update properties of the specified Golden Config node.
Route
PUT /configuration_manager/configs/:treeId/:version/:nodePath(*)
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| treeId |
string |
yes |
- |
| version |
string |
yes |
- |
| nodePath |
string |
yes |
- |
| name |
string |
yes |
New name of the node |
| attributes |
object |
yes |
Attributes to update. Will be shallow merged. |
Copied to Clipboard
{
"nodePath": "base/US East/Atlanta",
"name": "Southeast",
"attributes": {
"devices": [
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl"
],
"configId": "5c35355dbebaa82eaf8113f0"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"nodePath": {
"title": "nodePath",
"$ref": "goldenConfigData#/definitions/goldenConfigNodePath"
},
"name": {
"title": "name",
"type": "string",
"examples": [
"Southeast"
]
},
"attributes": {
"title": "attributes",
"type": "object",
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "deviceData#/definitions/deviceName"
}
},
"configId": {
"$ref": "common#/definitions/mongoObjectId"
}
}
}
},
"required": [
"nodePath",
"name",
"attributes"
],
"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"
]
}
}
}
