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": "in"
},
"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": 88929540,
"list": [
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "cillum",
"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": [
"3e76aadb5d061d2faf80fa75",
"45530843fc5de378b46f76a5",
"c1a121ec285975cd9ea35dfc"
],
"read": []
}
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "sit anim veniam Lorem",
"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": [
"fd53f9408b8f75261640cab8",
"6bf47c936eb526cbde820bc5",
"da5cec53e447406f87157a2c"
],
"read": []
}
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "est anim Lorem dolore 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": [
"58ead1f7a953121022ded2ca"
],
"read": [
"227b4cdd317933c2f010c279"
]
}
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "qui 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": [
"52b8082f42f59f73179ec3ca",
"b15707a94f77a5d2a0216081"
],
"read": [
"cd4b898f90c27bfd00572d72",
"2b2e1fc5d4eb76858058e320"
]
}
},
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "laborum ullamco sunt",
"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": [
"55613a489ca7ed057aae91e1"
]
}
}
]
}
Copied to Clipboard
{
"title": "backups",
"type": "object",
"properties": {
"total": {
"type": "integer",
"minimum": 0
},
"list": {
"type": "array",
"items": {
"$ref": "deviceData#/definitions/backup"
}
}
}
}