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: application/xml — the client can send this value in the header to accept response in the XML format. application/json — the client must send this value in the header to accept the request in the JSON format. If the request does not contain the header, the server will return the response in the XML format.

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.

False

Identifies the format of the response. Possible values:

application/xml — the client can send this value in the header to accept response in the XML format.
application/json — the client must send this value in the header to accept the request in the JSON format.

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@2015-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: CDP Full ReverseIncrement Increment Snapshot
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: Unknown Ready Failover Failback PermanentFailover

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: application/xml application/json

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message. Possible values:

application/xml
application/json

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">
<Entities>
<CloudVmReplicaPoints>
<CloudReplica Type="CloudVmReplicaPoint" Href="https://localhost:9398/api/cloud/vmReplicaPoints/8c027f2a-12a1-4c6f-a2af-d33e9a2c7b34?format=Entity" Name="filesrv03@2021-06-22 20:01:11" UID="urn:veeam:CloudVmReplicaPoint:8c027f2a-12a1-4c6f-a2af-d33e9a2c7b34" VmDisplayName="filesrv03">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ca19249e-e638-421a-ab22-68cb89b9009a" Name="172.24.31.67" />
<Link Rel="Up" Type="CloudReplicaReference" Href="https://localhost:9398/api/cloud/replicas/8e7b8830-e42a-4b3e-b4fe-b52f1fccc91a" Name="filesrv03" />
<Link Rel="Alternate" Type="CloudVmReplicaPointReference" Href="https://localhost:9398/api/cloud/vmReplicaPoints/8c027f2a-12a1-4c6f-a2af-d33e9a2c7b34" Name="filesrv03@2021-06-22 20:01:11" />
</Links>
<CreationTimeUTC>2021-06-22T20:01:11Z</CreationTimeUTC>
<PointType>Snapshot</PointType>
<State>Ready</State>
</CloudReplica>
<CloudReplica Type="CloudVmReplicaPoint" Href="https://localhost:9398/api/cloud/vmReplicaPoints/db1643e6-6775-4f22-98ca-ddd4ca4c715c?format=Entity" Name="filesrv03@2021-06-21 20:01:04" UID="urn:veeam:CloudVmReplicaPoint:db1643e6-6775-4f22-98ca-ddd4ca4c715c" VmDisplayName="filesrv03">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ca19249e-e638-421a-ab22-68cb89b9009a" Name="172.24.31.67" />
<Link Rel="Up" Type="CloudReplicaReference" Href="https://localhost:9398/api/cloud/replicas/8e7b8830-e42a-4b3e-b4fe-b52f1fccc91a" Name="filesrv03" />
<Link Rel="Alternate" Type="CloudVmReplicaPointReference" Href="https://localhost:9398/api/cloud/vmReplicaPoints/db1643e6-6775-4f22-98ca-ddd4ca4c715c" Name="filesrv03@2021-06-21 20:01:04" />
</Links>
<CreationTimeUTC>2021-06-21T20:01:04Z</CreationTimeUTC>
<PointType>Snapshot</PointType>
<State>Ready</State>
</CloudReplica>
<CloudReplica Type="CloudVmReplicaPoint" Href="https://localhost:9398/api/cloud/vmReplicaPoints/21cd3595-4274-41dc-b066-035bc94a12e5?format=Entity" Name="filesrv03@2021-06-20 20:00:57" UID="urn:veeam:CloudVmReplicaPoint:21cd3595-4274-41dc-b066-035bc94a12e5" VmDisplayName="filesrv03">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ca19249e-e638-421a-ab22-68cb89b9009a" Name="172.24.31.67" />
<Link Rel="Up" Type="CloudReplicaReference" Href="https://localhost:9398/api/cloud/replicas/8e7b8830-e42a-4b3e-b4fe-b52f1fccc91a" Name="filesrv03" />
<Link Rel="Alternate" Type="CloudVmReplicaPointReference" Href="https://localhost:9398/api/cloud/vmReplicaPoints/21cd3595-4274-41dc-b066-035bc94a12e5" Name="filesrv03@2021-06-20 20:00:57" />
</Links>
<CreationTimeUTC>2021-06-20T20:00:57Z</CreationTimeUTC>
<PointType>Snapshot</PointType>
<State>Ready</State>
</CloudReplica>
<CloudReplica Type="CloudVmReplicaPoint" Href="https://localhost:9398/api/cloud/vmReplicaPoints/0a34420d-f193-4207-b8aa-5a7e583e888c?format=Entity" Name="filesrv03@2021-03-17 21:03:34" UID="urn:veeam:CloudVmReplicaPoint:0a34420d-f193-4207-b8aa-5a7e583e888c" VmDisplayName="filesrv03">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ca19249e-e638-421a-ab22-68cb89b9009a" Name="172.24.31.67" />
<Link Rel="Up" Type="CloudReplicaReference" Href="https://localhost:9398/api/cloud/replicas/8e7b8830-e42a-4b3e-b4fe-b52f1fccc91a" Name="filesrv03" />
<Link Rel="Alternate" Type="CloudVmReplicaPointReference" Href="https://localhost:9398/api/cloud/vmReplicaPoints/0a34420d-f193-4207-b8aa-5a7e583e888c" Name="filesrv03@2021-03-17 21:03:34" />
</Links>
<CreationTimeUTC>2021-03-17T21:03:34Z</CreationTimeUTC>
<PointType>Snapshot</PointType>
<State>Ready</State>
</CloudReplica>
<CloudReplica Type="CloudVmReplicaPoint" Href="https://localhost:9398/api/cloud/vmReplicaPoints/db5e4ed2-9c6c-4e0a-be62-f0378d3ec4c5?format=Entity" Name="filesrv03@2021-03-16 21:03:17" UID="urn:veeam:CloudVmReplicaPoint:db5e4ed2-9c6c-4e0a-be62-f0378d3ec4c5" VmDisplayName="filesrv03">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ca19249e-e638-421a-ab22-68cb89b9009a" Name="172.24.31.67" />
<Link Rel="Up" Type="CloudReplicaReference" Href="https://localhost:9398/api/cloud/replicas/8e7b8830-e42a-4b3e-b4fe-b52f1fccc91a" Name="filesrv03" />
<Link Rel="Alternate" Type="CloudVmReplicaPointReference" Href="https://localhost:9398/api/cloud/vmReplicaPoints/db5e4ed2-9c6c-4e0a-be62-f0378d3ec4c5" Name="filesrv03@2021-03-16 21:03:17" />
</Links>
<CreationTimeUTC>2021-03-16T21:03:17Z</CreationTimeUTC>
<PointType>Snapshot</PointType>
<State>Ready</State>
</CloudReplica>
</CloudVmReplicaPoints>
</Entities>
<PagingInfo PagesCount="2" PageSize="5" PageNum="1">
<Links>
<Link Rel="First" Href="https://localhost:9398/api/query?type=CloudVmReplicaPoint&format=Entities&sortDesc=CreationTime&pageSize=5&page=1&filter=VmName==filesrv03" />
<Link Rel="Next" Href="https://localhost:9398/api/query?type=CloudVmReplicaPoint&format=Entities&sortDesc=CreationTime&pageSize=5&page=2&filter=VmName==filesrv03" />
<Link Rel="Last" Href="https://localhost:9398/api/query?type=CloudVmReplicaPoint&format=Entities&sortDesc=CreationTime&pageSize=5&page=2&filter=VmName==filesrv03" />
</Links>
</PagingInfo>
</QueryResult>