This is an archive version of the document. To get the most up-to-date information, see the current version.Removing Backups from Backup Repositories
This section explains how to remove backups by specified the identification number of the VM.
Request
POST https://<hostname>/api/v1/virtualMachines/{id}/deleteBackups |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Description |
id | The identification numbers of the backup policy. Can be obtained as described in Getting Backup Policies. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
Property | Type | Description |
|---|---|---|
id | string | Shows the identification number of the session. |
type | string | Shows the type of the session. |
executionStartTime | string | Shows at what time the session was started. |
executionStopTime | string | Shows at what time the session was finished. |
executionDuration | string | Shows the execution time. |
status | string | Shows the status. |
usn | integer | Shows the version of the backup policy. Used by platform services to detect if a backup policy has been changed since the last sync. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
Request: POST https://abc.ukwest.cloudapp.azure.com/api/v1/virtualMachines/ej43ifg58cgjs8e9cod74ye6cbwm5nttf6ijzk64rshqoip1abqy/deleteBackups
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "id": "11", "type": "BackupDeletion", "executionStartTime": "2020-02-03T13:53:00.4098143Z", "executionDuration": "00:00:00.0837798", "status": "Running", "usn": 0, "_links": { "self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/11"}, "log": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/11/log"} } } |