This is an archive version of the document. To get the most up-to-date information, see the current version.Taking Snapshots of Virtual Machines
This section explains how to manually take a snapshot of the specified virtual machine.
Request
POST https://<hostname>/api/v1/virtualMachines/takeSnapshot |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
Property | Type | Description |
id | string | Sets the name of the virtual machines of which you want to take a manual snapshot. Can be obtained as described in Getting Virtual Machines. |
Request Example
Request: POST https://<hostname>/api/v1/virtualMachines/takeSnapshot
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "virtualMachines": [ { "id": "ej43ifg58cgjs8e9cod74ye6cbwm5nttf6ijzk64rshqoip1abqy" } ] } |
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
The response contains the following information.
Property | Type | Description |
|---|---|---|
id | string | Shows the identification number of the session. |
type | string | Shows the type of the session. |
status | string | Shows the status of the session. |
usn | integer | Shows the version of the backup policy. Used by platform services to detect if a backup policy has been hanged since the last sync. |
backupJobInfo | Contains the BackupJobInfo object. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
For more information about sessions, see the Sessions Statistics section of the Veeam Backup for Microsoft Azure User Guide.
Property | Type | Description |
|---|---|---|
policyId | string | Shows the identification number of the policy. |
protectedInstancesCount | integer | Shows the number of objects to backup. |
policyRemoved | boolean | Shows if the policy is removed. |
Response Example
Response: 200 OK
Response Body: { "id": "7", "type": "ManualSnapshot", "status": "Pending", "usn": 0, "backupJobInfo": { "policyId": "00000000-0000-0000-0000-000000000000", "protectedInstancesCount": 0, "policyRemoved": false }, "_links": { "self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/7"}, "log": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/7/log"} } } |