Summary
Import backup documents
Description
Insert backup documents into the ucm_configs collection
Route
POST /configuration_manager/import/backups
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
backups |
array |
yes |
Array of device configs |
Copied to Clipboard
{
"backups": [
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "sed sunt est anim consequat",
"type": "native",
"date": "2019-04-12T14:42:47.958Z",
"rawConfig": "hostname ios0\nno service password-encryption\n...",
"description": "description of backup",
"notes": "notes about backup",
"gbac": {
"write": [],
"read": [
"ba396e0c2fd344235a918946",
"b2b9d64c235a5e7353d22c3a",
"6bc0de9f0166d0b7da896d4c"
]
}
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "sed",
"type": "native",
"date": "2019-04-12T14:42:47.958Z",
"rawConfig": "hostname ios0\nno service password-encryption\n...",
"description": "description of backup",
"notes": "notes about backup",
"gbac": {
"write": [
"fcb9f342c330b2991dc81de4",
"9a4e38856cbb1b754351e0e2"
],
"read": [
"749bb58ae08e67cf411fe746"
]
}
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "nisi Lorem cillum non mollit",
"type": "native",
"date": "2019-04-12T14:42:47.958Z",
"rawConfig": "hostname ios0\nno service password-encryption\n...",
"description": "description of backup",
"notes": "notes about backup",
"gbac": {
"write": [
"538f3f094a3f933a114c3b48"
],
"read": [
"d26ab0850b84939eb9bcf61b",
"0b11d346aae79e81d59cd28f"
]
}
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"backups": {
"title": "backups",
"type": "array",
"items": {
"$ref": "deviceData#/definitions/backup"
}
}
},
"required": [
"backups"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
status |
object |
Status of backup import operation |
Copied to Clipboard
{
"status": "success",
"message": "id est dolor nulla elit"
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"example": "2 device backups imported successfully"
}
}
}