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": "amet culpa mollit"
},
"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": 21164772,
"list": [
{
"id": "5c35355dbebaa82eaf8113f0",
"name": "xr9kv-atl",
"provider": "anim",
"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": [
"881fff9a184797b33c92eb94",
"1f6a519bb0e6df8952a5c5ca",
"de801fcde3102a5e07b6e703",
"d51b06ec8e7de598f8120f00"
],
"read": [
"79ee6774f8b28474ff8621d6",
"cf2e0659a1f89b39db7d85cc",
"93187b8514d18a8431a5d99f"
]
}
}
]
}
Copied to Clipboard
{
"title": "backups",
"type": "object",
"properties": {
"total": {
"type": "integer",
"minimum": 0
},
"list": {
"type": "array",
"items": {
"$ref": "deviceData#/definitions/backup"
}
}
}
}
