GET /query?type=CloudVmReplicaPoint
Returns a resource representation of a collection of restore points for separate VMs that are replicated with tenant replication jobs. For details, see /cloud/vmReplicaPoints.
The collection includes restore points of the following replica types:
- Regular replicas for VMware vSphere, Microsoft Hyper-V and VMware Cloud Director
- CDP replicas
- VMware Cloud Director CDP replicas
Request
To get a list of restore points, send the GET HTTP request to the query with the type parameter set to CloudVmReplicaPoint.
HTTP Request
|
GET https://<Enterprise-Manager>:9398/api/query?type=CloudVmReplicaPoint |
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.
Optional Parameters
In the query, you can use the following parameters for filtering and sorting.
|
Parameter |
Type |
Description |
|---|---|---|
|
UID |
UidType |
ID of the VM replica point resource. |
|
Name |
String |
Name of the VM replica point, for example: dc-hv@2025-12-25 20:03:56. |
|
CreationTime |
DateTime |
Date and time when the restore point was created. The parameter accepts only UTC-formatted DateTime values. |
|
VmName |
String |
Name of the tenant VM for which the restore point has been created. |
|
Type |
String |
Type of the VM replica point. Possible values:
|
|
ReplicaUid |
UidType |
UID of the tenant VM replica parent to the VM replica point resource. |
|
ReplicaName |
String |
Name of the tenant VM replica parent to the VM replica point resource. |
|
VmDisplayName |
String |
Name of the tenant VM for which the restore point has been created. |
|
BackupServerUid |
UidType |
UID of the backup server on which the account of the tenant who has created the VM replica restore point had been created. |
|
BackupServerName |
String |
Name of the backup server on which the account of the tenant who has created the VM replica restore point had been created. |
|
State |
String |
State of the tenant VM replica. Possible values:
|
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 a representation of the /cloud/vmReplicaPoints resource collection.
Example
The example below returns an entity resource representation of a collection of of last 5 replica restore points created for VM filesrv03. The results are ordered in the descending order by the CreationTime parameter.
|
Request: GET https://localhost:9398/api/query?type=CloudVmReplicaPoint&format=Entities&sortDesc=CreationTime&pageSize=5&page=1&filter=VmName==filesrv03 Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 OK Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0"> |