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": "treeJunos",
"_id": "8c64681c-29b0-d2f5-43f8-4351078603e0"
},
{
"label": "treeJunos",
"_id": "5fd4d365-9aea-8f27-f919-7b6bbfe9678a"
},
{
"label": "treeArista",
"_id": "ab52d269-91c7-757b-c22b-a306c7c1ed7f"
},
{
"label": "treeArista",
"_id": "eaff3628-53c0-bf2d-24cc-241859c4f260"
},
{
"label": "treeArista",
"_id": "0cc81d7a-be39-5985-4b32-9c9e9650612f"
}
]
}
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": "treeJunos",
"_id": "SUCCESS"
},
{
"label": "treeArista",
"_id": "SUCCESS"
},
{
"label": "treeArista",
"_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"
]
}
}