Summary
Updates properties of a Golden Config tree version
Description
Updates properties of the specified Golden Config tree version
Route
PUT /configuration_manager/configs/:treeId/:version
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| treeId |
string |
yes |
- |
| version |
string |
yes |
- |
| name |
string |
yes |
New name of the tree version. |
| variables |
array |
yes |
The configuration variables defined on this version. |
Copied to Clipboard
{
"name": "updated version name",
"variables": [
{
"name": "variable name",
"type": "regex",
"value": "variable value"
},
{
"name": "variable name",
"type": "literal",
"value": "variable value"
},
{
"name": "variable name",
"type": "regex",
"value": "variable value"
},
{
"name": "variable name",
"type": "regex",
"value": "variable value"
},
{
"name": "variable name",
"type": "regex",
"value": "variable value"
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string",
"examples": [
"updated version name"
]
},
"variables": {
"title": "variables",
"$ref": "goldenConfigData#/definitions/goldenConfigVariables"
}
},
"required": [
"name",
"variables"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| updateResult |
object |
status of creation and the new tree, if successful |
Copied to Clipboard
{
"status": "success",
"message": "Configuration tree version updated"
}
Copied to Clipboard
{
"title": "updateResult",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"examples": [
"Configuration tree version updated"
]
}
}
}
