Summary
Deletes one or more variables
Description
Verifies and deletes the requested deletion variables
Route
DELETE /configuration_manager/configs/variables/:treeId/:version
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| treeId |
string |
yes |
- |
| version |
string |
yes |
- |
| variables |
array |
yes |
The configuration variables defined on this version. |
Copied to Clipboard
{
"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": "literal",
"value": "variable value"
}
]
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| deleteResult |
object |
status of the variables to delete |
Copied to Clipboard
{
"status": "success",
"message": "Deletion successful."
}
Copied to Clipboard
{
"title": "deleteResult",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"examples": [
"Deletion successful."
]
}
}
}