Summary
Delete one or more device backups by Id
Description
This API call will delete device backups based on given Ids
Route
DELETE /configuration_manager/backups
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| backupIds |
array |
yes |
Array of device backup Ids |
Copied to Clipboard
{
"backupIds": [
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0",
"5c35355dbebaa82eaf8113f0"
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"backupIds": {
"title": "backupIds",
"type": "array",
"items": {
"$ref": "common#/definitions/mongoObjectId"
}
}
},
"required": [
"backupIds"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| Status |
object |
Status with the number of device backups deleted |
Copied to Clipboard
{
"status": "success",
"deleted": 41859253
}
Copied to Clipboard
{
"title": "Status",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"success",
"conflict"
]
},
"deleted": {
"type": "integer",
"minimum": 0
}
}
}
