- URL:
- https://<root>/system/disasterrecovery/backuprestore/backups/<backupName>/delete
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The delete operation removes a specific backup from a deployment. This operation cannot be reversed. Before performing this operation, take time to ensure that critical data won't deleted by mistake. Once the operation is complete, the backup files are permanently removed from the backup store and cannot be retrieved.
Request parameters
| Parameter | Details |
|---|---|
| Introduced at 11.0. This parameter specifies whether the operation will run synchronously or asynchronously. If Values: |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the delete operation:
POST /<context>/admin/system/disasterrecovery/backuprestore/backups/backup/delete HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
async=false&f=pjson&token=HRozb6bnTL6gfA-SJO-IxhfLgJrioK1KJdMLWmCE5HjHWz9U3fOiFv3-HkgPZqsLljTkk2WDENGt5fjho5s39e_mZL5At60UvJPoNnC5O2sv2HTlumG7TsYfbtnokpWmS6-lf8XoQpSKusZwmxIkEMP-yE0Wxrj8o9sWKi29J-pxzkoCDhoUfdLt6NnBWxhESpegh8BzNcEruqxuDQD-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1eJSON Response examples
The following response is returned, if async is false, when a backup is successfully deleted:
{"status": "success"}If async is true, the response returns a JSON object containing job information. The value returned for the jobs property can be used to access the job resource, which can be polled to return updated job status information. For more information, see the Job resource topic.
{
"jobsUrl": "https://organization.example.com/<context>/admin/jobs/j7c8820d0-ea2f-427a-ab6f-a8cc2c927fe4",
"jobid": "j7c8820d0-ea2f-427a-ab6f-a8cc2c927fe4",
"status": "SUBMITTED"
}