Summary
Import golden config tree documents
Description
Insert golden config documents into the golden config collection
Route
POST /configuration_manager/import/goldenconfigs
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
trees |
array |
yes |
Array of golden config trees |
options |
object |
no |
- |
Copied to Clipboard
{
"trees": [
{
"data": [
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "Cisco Edge - Day 1",
"deviceType": "a10-acos",
"versions": [
"initial",
"v2"
],
"created": "2019-04-12T14:42:47.958Z",
"lastUpdated": "2019-04-12T14:42:47.958Z"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "Cisco Core - Day 1",
"deviceType": "f5-big-ip",
"versions": [
"initial",
"initial"
],
"created": "2019-04-12T14:42:47.958Z",
"lastUpdated": "2019-04-12T14:42:47.958Z"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "Cisco Core - Day 0",
"deviceType": "cisco-ios",
"versions": [
"v3",
"draft v4"
],
"created": "2019-04-12T14:42:47.958Z",
"lastUpdated": "2019-04-12T14:42:47.958Z"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "Cisco Edge - Day 1",
"deviceType": "cisco-nx",
"versions": [
"v2"
],
"created": "2019-04-12T14:42:47.958Z",
"lastUpdated": "2019-04-12T14:42:47.958Z"
}
]
},
{
"data": [
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "Cisco Core - Day 1",
"deviceType": "a10-acos",
"versions": [
"v3",
"v3",
"draft v4",
"draft v4",
"draft v4"
],
"created": "2019-04-12T14:42:47.958Z",
"lastUpdated": "2019-04-12T14:42:47.958Z"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "Cisco Edge - Day 0",
"deviceType": "cisco-ios",
"versions": [
"draft v4",
"draft v4",
"initial"
],
"created": "2019-04-12T14:42:47.958Z",
"lastUpdated": "2019-04-12T14:42:47.958Z"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "Cisco Core - Day 0",
"deviceType": "cisco-ios-xr",
"versions": [
"v2",
"v3"
],
"created": "2019-04-12T14:42:47.958Z",
"lastUpdated": "2019-04-12T14:42:47.958Z"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "Cisco Core - Day 0",
"deviceType": "a10-acos",
"versions": [
"v2"
],
"created": "2019-04-12T14:42:47.958Z",
"lastUpdated": "2019-04-12T14:42:47.958Z"
}
]
},
{
"data": [
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "Cisco Core - Day 1",
"deviceType": "cisco-nx",
"versions": [
"v3"
],
"created": "2019-04-12T14:42:47.958Z",
"lastUpdated": "2019-04-12T14:42:47.958Z"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "Cisco Edge - Day 0",
"deviceType": "cisco-ios-xr",
"versions": [
"initial"
],
"created": "2019-04-12T14:42:47.958Z",
"lastUpdated": "2019-04-12T14:42:47.958Z"
}
]
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"trees": {
"title": "trees",
"type": "array",
"items": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Documents of given tree per version",
"items": {
"type": "object",
"$ref": "goldenConfigData#/definitions/goldenConfigTreeVersionSummary"
}
}
}
}
},
"options": {
"title": "options",
"type": "object",
"properties": {},
"required": []
}
},
"required": [
"trees"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
status |
object |
Status of golden config import operation |
Copied to Clipboard
{
"status": "success",
"message": "mollit commodo officia velit"
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"example": "2 golden config trees imported successfully"
}
}
}