The Delete Backup Set command permanently deletes a backup set from the database for one computer only.
You also have the option of deleting all the revisions associated with the backup set (use this option only if you do not need to restore this data).
This section provides the following topics:
- Input Parameters
- Output Parameters
- Error Codes
Input Parameters
Headers:
- Authorization: Oauth TOKEN
- Accept: application/json
- Content-Type: application/json
Required scope: computers_write
The following table provides the input parameters and descriptions.
Input Parameter | Description |
backupSetId | Numeric Id of the backup set to be deleted. The id of the backup set is obtained using a different REST API call. |
deleteData | This optional Boolean parameter specifies deleting the revision data together with the backup set. The default value is false (do not delete the data together with the backup set). Note: The deletion of data together with the backup set is supported only for the following:
It is not currently supported for Files and Folders, SQL, or Exchange. |
Example
The following is the command for deleting a backup set with the associated data.
POST /v2/accounts/computers/0000/backupsets/delete
"backupSetId": 1,
"deleteData": true
}
Output Parameters
Status is obtained with the same command that gets status for backup set creation displayed below.
GET /v2/account/computers/0000/backupsets/3/info
The status is either success or error with the reason for the failure.
Example
Successful status is returned as shown in the following example.
{
"data": {
"id": 1
}
}
The “id” from the result is the one used in the follow-up command to get the status:
GET /v2/accounts/computers/0000/backupsets/3/info
Error Codes
The reason for the failure is described with the error codes in the following table.
Error Code | Description |
BackupSetActions_NotFound | Cannot find the backup set corresponding to the provided id. |
BackupActions_BackupSetRunning | The backup set you are trying to delete is running. |
Configuration_ReadOnlyInstallation | The subaccount is read-only (delete of any kind is prohibited). This error should never be possible; however, it exists in the core API. |
Lock File Error Codes
The reason for the failure is described with the lock file error codes in the following table.
Lock File Error Code | Description |
CheckLockFileMismatch | The subaccount is installed elsewhere. |
| Should never happen. Retrying does not work. It is not a network disconnected issue. It is likely an exception occurred in the Maestro call checking the lock file or there is something wrong with the app server or file server. Because the lock file is stored in the file servers, it can also mean a file server issue. |
Offline Operation
Response status: 202 Accepted (for offline operation)
Example Response
{
"data": {
"id": 3
}
}
id - remote action ID, which is used to check the status of the operation
Status is obtained via the same command that gets status for Backup Set Creation.