Summary
Delete trees
Description
Delete multiple Golden Config Trees.
Route
POST /golden_config/deleteTrees
Roles
admin
engineering
support
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
trees |
array |
yes |
List of trees to delete. |
Copied to Clipboard
{
"trees": [
{
"label": "treeArista",
"_id": "e5e69b04-28a7-dfa4-5678-2df937c585fa"
},
{
"label": "treeCisco",
"_id": "ea0a32d7-2e85-6d38-1084-b9768084ec30"
},
{
"label": "treeJunos",
"_id": "61aeb1c9-b630-1e9d-14c6-95deba9b2a1e"
},
{
"label": "treeArista",
"_id": "31403641-2a60-d972-366a-b0ee7fa53bc0"
},
{
"label": "treeCisco",
"_id": "d3a5284e-e324-bbb8-f68b-ec0bf559ca6d"
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"trees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"examples": [
"treeCisco",
"treeJunos",
"treeArista"
]
},
"_id": {
"$ref": "IDType"
}
},
"required": [
"label",
"_id"
]
}
}
},
"required": [
"trees"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
trees |
array |
List of tree names that were deleted |
Copied to Clipboard
[
{
"label": "treeCisco",
"_id": "SUCCESS"
},
{
"label": "treeCisco",
"_id": "SUCCESS"
},
{
"label": "treeCisco",
"_id": "SUCCESS"
}
]
Copied to Clipboard
{
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"examples": [
"treeCisco",
"treeJunos",
"treeArista"
]
},
"_id": {
"type": "string",
"enum": [
"SUCCESS"
]
}
},
"required": [
"label",
"status"
]
}
}