Summary
Get Device Backup List
Description
Fetches backups, requires an options payload. An empty option payload will return the first 25 documents
Route
POST /configuration_manager/backups
Roles
admin
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
options |
object |
yes |
options payload for querying backup documents |
Copied to Clipboard
{
"options": {
"start": 0,
"limit": 20,
"regex": true,
"filter": {
"name": "culpa"
},
"sort": {
"name": 1,
"date": 1
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"title": "options",
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"examples": [
0
]
},
"limit": {
"type": "integer",
"minimum": 1,
"examples": [
20
]
},
"regex": {
"type": "boolean"
},
"filter": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"sort": {
"type": "object",
"properties": {
"name": {
"enum": [
-1,
1
]
},
"date": {
"enum": [
-1,
1
]
}
}
}
}
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
backups |
object |
List of all backups and the total |
Copied to Clipboard
{
"total": 74680524,
"list": [
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "Lorem aliquip id dolor",
"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": []
}
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "exercitation",
"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": [
"e9b35fabe5da680b1d3b0f46",
"3631a0cd7c09e42eb996288c",
"b5eb02504f4736a654f596b3"
],
"read": [
"30bab2385f358546d6c4a546"
]
}
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "amet officia ut",
"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": [
"f8f06e4f13a1d80505aa16fe"
],
"read": [
"3c69a5ec27e58faf1e5075b9"
]
}
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "sunt culpa sint nostrud",
"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": [
"505b28619b106574775a7643",
"17acb9d77ed62582c002e60a"
],
"read": [
"b888d6eaca376abf00eb1b72",
"f1d9d75f0420f889931a5dbc",
"b8a3d3a32d351e5e99eb2f5a",
"8836a22a67015c0d22472812"
]
}
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "nisi",
"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": [
"ca33b5e72e27323f90e36eaa",
"76c546e0817bf372058e22a9",
"a5320715e823727794e05a55",
"15762371ab6a8adc7d4b1f1a"
],
"read": [
"f20058308f8da65678ab97eb",
"60999383194a5048d79dce9d",
"4ad069aaabadeab866eed233"
]
}
}
]
}
Copied to Clipboard
{
"title": "backups",
"type": "object",
"properties": {
"total": {
"type": "integer",
"minimum": 0
},
"list": {
"type": "array",
"items": {
"$ref": "deviceData#/definitions/backup"
}
}
}
}