Summary
Updates properties of a Golden Config tree
Description
Updates properties of the specified Golden Config tree
Route
PUT /configuration_manager/configs/:treeId
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| treeId |
string |
yes |
- |
| options |
object |
yes |
options to update |
Copied to Clipboard
{
"options": {
"name": "GC Tree Name",
"gbac": {
"read": [
"63696917c49ecc7b03b5f02b"
],
"write": [
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b",
"63696917c49ecc7b03b5f02b"
]
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"title": "options",
"type": "object",
"properties": {
"name": {
"type": "string",
"examples": [
"GC Tree Name"
]
},
"gbac": {
"type": "object",
"properties": {
"read": {
"type": "array",
"items": {
"type": "string",
"examples": [
"63696917c49ecc7b03b5f02b"
]
}
},
"write": {
"type": "array",
"items": {
"type": "string",
"examples": [
"63696917c49ecc7b03b5f02b"
]
}
}
}
}
}
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| updateResult |
object |
- |
Copied to Clipboard
{
"status": "success",
"message": "Golden Config tree updated"
}
Copied to Clipboard
{
"title": "updateResult",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"examples": [
"Golden Config tree updated"
]
}
}
}
