DELETE /backup_and_restore/backups/{id}

Sends a request to the Backup and Restore Engine to delete an existing backup.

Deleting a backup that is INITIALIZING or IN_PROGRESS will cancel the backup.

Table 1. DELETE /backup_and_restore/backups/{id} resource details
MIME Type
application/json

Table 2. DELETE /backup_and_restore/backups/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	Required. The ID of the backup to delete.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. DELETE /backup_and_restore/backups/{id} response codes
HTTP Response Code	Unique Code	Description
202		A request was successfully sent to deleted the backup.
404	1001	The backup does not exist.
422	1017	Backups can be deleted only in the following states: INITIALIZING, IN_PROGRESS, FAILED, SUCCESS, MISSING.
500	1000	An error occurred during the attempt to delete the backup.

Response Description

Response Sample


{
    "build_version": "String",
    "configuration_id": 42,
    "content_file_path": "String",
    "description": "String",
    "host_id": 42,
    "id": 42,
    "intiated_by": "String",
    "is_valid": true,
    "is_version_compatible": true,
    "name": "String",
    "size_on_disk": 42,
    "status": "String",
    "time_completed": 42,
    "time_initiated": 42,
    "type": "String",
    "version": "String"
}