This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /cloud/vmReplicaPoints/{ID}
Returns a resource representation of a VM replica restore point that has the specified ID. VM is replicated with the tenant replication job.
Request
To get a restore point for a specific tenant VM replica, you need to send the GET HTTP request to the URL of the /cloud/vmReplicaPoints/{ID} resource.
HTTP Request
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Query Parameters
The following parameters can be used in queries.
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
|---|---|---|---|---|
Uid | URN | ID of the VM replica point resource. | True | True |
Name | String | Name of the VM replica point, for example: dc-hv@2015-12-25 20:03:56. | True | True |
CreationTime | DateTime | Date and time when the restore point was created. The parameter accepts only UTC-formatted DateTime values. | True | True |
VmName | String | Name of the tenant VM for which the restore point has been created. | True | True |
Type | String | Type of the VM replica point. Possible values:
| True | True |
ReplicaUid | URN | ID of the tenant VM replica parent to the VM replica point resource. | True | True |
ReplicaName | String | Name of the tenant VM replica parent to the VM replica point resource. | True | True |
VmDisplayName | String | Name of the tenant VM for which the restore point has been created. | True | True |
BackupServerUid | URN | ID of the Veeam backup server on which the account of the tenant who has created the VM replica restore point had been created. | True | True |
BackupServerName | String | Name of the Veeam backup server on which the account of the tenant who has created the VM replica restore point had been created. | True | True |
State | String | State of the tenant VM replica. Possible values:
| True | True |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message. Possible values:
|
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /cloud/vmReplicaPoints/{ID} resource.
Example
The example below returns an entity resource representation of the VM replica restore point having ID 93081441-6e3c-4584-b47a-08dc1ce24f84:
Request: GET https://localhost:9398/api/vmReplicaPoints/93081441-6e3c-4584-b47a-08dc1ce24f84?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <CloudVmReplicaPoint xmlns="http://www.veeam.com/ent/v1.0" Type="CloudVmReplicaPoint" Href="https://localhost:9398/api/cloud/vmReplicaPoints/93081441-6e3c-4584-b47a-08dc1ce24f84?format=Entity" Name="srv39@2015-12-25 20:00:47" UID="urn:veeam:CloudVmReplicaPoint:93081441-6e3c-4584-b47a-08dc1ce24f84" VmDisplayName="srv39"> |
