GET /vmRestorePoints/{ID}
Returns a resource representation of a VM restore point having the specified ID.
Supported Platforms
The request is supported for the following platforms:
- VMware vSphere
- VMware Cloud Director
- Microsoft Hyper-V
Request
To get a VM restore point, send the GET HTTP request to the URL of the /vmRestorePoints/{ID} resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/vmRestorePoints/{ID} |
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. For details, 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.
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, the REST API returns an entity or an entity reference of the /vmRestorePoints/{ID} resource. The resource entity contains the following parameters and links.
Parameters
Element | Type | Description |
|---|---|---|
UID | UidType | UID of the VM backup point resource. |
Name | String | Name of the VM backup restore point, for example: sql01-hv@2013-08-24 05:03:25. |
CreationTime | DateTime | Date and time when the restore point was created. The parameter accepts only UTC-formatted DateTime values. |
VmName | String | Name of the VM for which the restore point has been created. |
Algorithm | String | Backup method used to create the restore point. Possible values:
|
PointType | String | Type of the VM backup restore point. Possible values:
|
HierarchyObjRef | HierarchyObjRefType | Reference to the VM. |
To view query parameters that you can use for filtering or sorting, see GET /query?type=VmRestorePoint.
Links
Reference | Relationship | Description |
|---|---|---|
/vmRestorePoints/{ID}?action=restore | Restore | URL for the POST /vmRestorePoints/{ID}?action=restore request. |
/backupServers/{ID} | Up | URL of the /backupServers/{ID} resource — a backup server that created the restore point. |
/restorePoints/{ID} | Up | URL of the /restorePoints/{ID} resource — a parent restore point. |
/backupFiles/{ID} | Up | URL of the /backupFiles/{ID} resource — a backup file related to the VM restore point. |
/vmRestorePoints/{ID} | Alternate | Alternate URL of the /vmRestorePoints/{ID} resource. |
/vmRestorePoints/{ID}/mounts | Down | URL of the /vmRestorePoints/{ID}/mounts resource — a collection of mount points that provide access to guest OS files of the VM. |
/vmRestorePoints/{ID}/mounts | Create | URL for the POST /vmRestorePoints/{ID}/mounts request. |
Example
The example below returns an entity resource representation of a VM restore point having ID 6c958531-3177-4055-b0ce-dc4ef1ce6433:
Request: GET https://localhost:9398/api/vmRestorePoints/6c958531-3177-4055-b0ce-dc4ef1ce6433?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <?xml version="1.0" encoding="utf-8"?> |