Summary
Update node configuration.
Description
Updates the configuration for a specified node.
Route
PUT /configuration_manager/node/config
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| treeId |
string |
yes |
- |
| treeVersion |
string |
yes |
- |
| nodePath |
string |
yes |
- |
| data |
object |
yes |
- |
| updateVariables |
boolean |
yes |
Update's the existing variables in a tree with the provided variables. |
Copied to Clipboard
{
"treeId": "5c35355dbebaa82eaf8113f0",
"treeVersion": "draft-v4",
"nodePath": "base/US East/Atlanta",
"data": {
"template": "ntp server {{ ipAddress }}",
"variables": "{ \"ipAddress\": \"128.31.1.3\"}"
},
"updateVariables": false
}
Copied to Clipboard
{
"type": "object",
"properties": {
"treeId": {
"title": "treeId",
"$ref": "common#/definitions/mongoObjectId"
},
"treeVersion": {
"title": "version",
"$ref": "goldenConfigData#/definitions/goldenConfigTreeVersionName"
},
"nodePath": {
"title": "nodePath",
"$ref": "goldenConfigData#/definitions/goldenConfigNodePath"
},
"data": {
"title": "data",
"type": "object",
"properties": {
"template": {
"type": "string",
"examples": [
"ntp server {{ ipAddress }}"
]
},
"variables": {
"type": "string",
"examples": [
"{ \"ipAddress\": \"128.31.1.3\"}"
]
}
}
},
"updateVariables": {
"title": "updateVariables",
"type": "boolean"
}
},
"required": [
"treeId",
"treeVersion",
"nodePath",
"data",
"updateVariables"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| nodeUpdateResult |
object |
- |
Copied to Clipboard
{
"status": "success",
"message": "Node Config updated"
}
Copied to Clipboard
{
"title": "nodeUpdateResult",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"examples": [
"Node Config updated"
]
}
}
}
