GET /vAppReplicaPoints

Returns a collection of restore points of separate vApps replicas.

Tip

To get a filtered and sorted collection of restore points of separate vApps replicas, send the GET /query?type=vAppRestorePoint request.

Request

To get a collection of restore points of separate vApps replicas, send the GET HTTP request to the URL of the /vAppReplicaPoints resource.

HTTP Request

GET https://<Enterprise-Manager>:9398/api/vAppReplicaPoints

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.

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:

application/xml
application/json

Response Body

In the response body, the REST API returns a representation of the /vAppReplicaPoints resource collection.

Example

The example below returns a list of all vApp replica restore points created on backup servers connected to Veeam Backup Enterprise Manager.

Request:

GET https://localhost:9398/api/vAppReplicaPoints

Request Header:

X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

Response:

200 OK

Response Body:

<EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
<Ref Type="VAppReplicaPointReference" Href="https://localhost:9398/api/vAppReplicaPoints/85f19572-2210-4620-937e-7cb0b85ab0de" Name="vApp01@2021-02-07 05:59:59" UID="urn:veeam:VAppReplicaPoint:85f19572-2210-4620-937e-7cb0b85ab0de">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/554dc718-37b7-4fb6-9e07-f97c6b5192aa" Name="enterprise04.tech.local" />
<Link Rel="Up" Type="ReplicaReference" Href="https://localhost:9398/api/replicas/2111ab48-0030-42c6-b69e-e91fc9653ef7" Name="vCD Replication Job 1" />
<Link Rel="Alternate" Type="VAppReplicaPoint" Href="https://localhost:9398/api/vAppReplicaPoints/85f19572-2210-4620-937e-7cb0b85ab0de?format=Entity" Name="vApp01@2021-02-07 05:59:59" />
<Link Rel="Down" Type="VmReplicaPointReference" Href="https://localhost:9398/api/vmReplicaPoints/caff3fbe-b908-45ab-b775-1480da57c673" Name="win7-QDrB@2021-02-07 05:59:59" />
</Links>
</Ref>
<Ref Type="VAppReplicaPointReference" Href="https://localhost:9398/api/vAppReplicaPoints/85f19572-2210-4620-937e-7cb0b85ab0de" Name="vApp01@2021-02-07 05:59:59" UID="urn:veeam:VAppReplicaPoint:85f19572-2210-4620-937e-7cb0b85ab0de">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/554dc718-37b7-4fb6-9e07-f97c6b5192aa" Name="enterprise04.tech.local" />
<Link Rel="Up" Type="ReplicaReference" Href="https://localhost:9398/api/replicas/2111ab48-0030-42c6-b69e-e91fc9653ef7" Name="vCD Replication Job 1" />
<Link Rel="Alternate" Type="VAppReplicaPoint" Href="https://localhost:9398/api/vAppReplicaPoints/85f19572-2210-4620-937e-7cb0b85ab0de?format=Entity" Name="vApp01@2021-02-07 05:59:59" />
<Link Rel="Down" Type="VmReplicaPointReference" Href="https://localhost:9398/api/vmReplicaPoints/8d600149-eaf3-4fde-a681-4135421d4a5f" Name="win2019-JG4k@2021-02-07 05:59:59" />
</Links>
</Ref>
<Ref Type="VAppReplicaPointReference" Href="https://localhost:9398/api/vAppReplicaPoints/85f19572-2210-4620-937e-7cb0b85ab0de" Name="vApp01@2021-02-07 05:59:59" UID="urn:veeam:VAppReplicaPoint:85f19572-2210-4620-937e-7cb0b85ab0de">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/554dc718-37b7-4fb6-9e07-f97c6b5192aa" Name="enterprise04.tech.local" />
<Link Rel="Up" Type="ReplicaReference" Href="https://localhost:9398/api/replicas/2111ab48-0030-42c6-b69e-e91fc9653ef7" Name="vCD Replication Job 1" />
<Link Rel="Alternate" Type="VAppReplicaPoint" Href="https://localhost:9398/api/vAppReplicaPoints/85f19572-2210-4620-937e-7cb0b85ab0de?format=Entity" Name="vApp01@2021-02-07 05:59:59" />
<Link Rel="Down" Type="VmReplicaPointReference" Href="https://localhost:9398/api/vmReplicaPoints/760181ee-2a82-4be3-ad5a-e893dc63bebd" Name="win2019_restored251120T1625-RG0j@2021-02-07 06:02:24" />
</Links>
</Ref>
<Ref Type="VAppReplicaPointReference" Href="https://localhost:9398/api/vAppReplicaPoints/dc01c979-5f6a-409c-bcc2-c3c6ddf439b3" Name="vApp01@2021-02-04 00:08:35" UID="urn:veeam:VAppReplicaPoint:dc01c979-5f6a-409c-bcc2-c3c6ddf439b3">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/554dc718-37b7-4fb6-9e07-f97c6b5192aa" Name="enterprise04.tech.local" />
<Link Rel="Up" Type="ReplicaReference" Href="https://localhost:9398/api/replicas/2111ab48-0030-42c6-b69e-e91fc9653ef7" Name="vCD Replication Job 1" />
<Link Rel="Alternate" Type="VAppReplicaPoint" Href="https://localhost:9398/api/vAppReplicaPoints/dc01c979-5f6a-409c-bcc2-c3c6ddf439b3?format=Entity" Name="vApp01@2021-02-04 00:08:35" />
<Link Rel="Down" Type="VmReplicaPointReference" Href="https://localhost:9398/api/vmReplicaPoints/34ed5f74-0184-4077-987a-36e41eef6668" Name="win7-QDrB@2021-02-04 01:49:04" />
</Links>
</Ref>
<Ref Type="VAppReplicaPointReference" Href="https://localhost:9398/api/vAppReplicaPoints/dc01c979-5f6a-409c-bcc2-c3c6ddf439b3" Name="vApp01@2021-02-04 00:08:35" UID="urn:veeam:VAppReplicaPoint:dc01c979-5f6a-409c-bcc2-c3c6ddf439b3">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/554dc718-37b7-4fb6-9e07-f97c6b5192aa" Name="enterprise04.tech.local" />
<Link Rel="Up" Type="ReplicaReference" Href="https://localhost:9398/api/replicas/2111ab48-0030-42c6-b69e-e91fc9653ef7" Name="vCD Replication Job 1" />
<Link Rel="Alternate" Type="VAppReplicaPoint" Href="https://localhost:9398/api/vAppReplicaPoints/dc01c979-5f6a-409c-bcc2-c3c6ddf439b3?format=Entity" Name="vApp01@2021-02-04 00:08:35" />
<Link Rel="Down" Type="VmReplicaPointReference" Href="https://localhost:9398/api/vmReplicaPoints/e48f152a-6a70-4571-ac80-0fd759847a8c" Name="win2019-JG4k@2021-02-04 00:08:35" />
</Links>
</Ref>
<Ref Type="VAppReplicaPointReference" Href="https://localhost:9398/api/vAppReplicaPoints/dc01c979-5f6a-409c-bcc2-c3c6ddf439b3" Name="vApp01@2021-02-04 00:08:35" UID="urn:veeam:VAppReplicaPoint:dc01c979-5f6a-409c-bcc2-c3c6ddf439b3">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/554dc718-37b7-4fb6-9e07-f97c6b5192aa" Name="enterprise04.tech.local" />
<Link Rel="Up" Type="ReplicaReference" Href="https://localhost:9398/api/replicas/2111ab48-0030-42c6-b69e-e91fc9653ef7" Name="vCD Replication Job 1" />
<Link Rel="Alternate" Type="VAppReplicaPoint" Href="https://localhost:9398/api/vAppReplicaPoints/dc01c979-5f6a-409c-bcc2-c3c6ddf439b3?format=Entity" Name="vApp01@2021-02-04 00:08:35" />
<Link Rel="Down" Type="VmReplicaPointReference" Href="https://localhost:9398/api/vmReplicaPoints/689c52a6-6ad2-4675-ac65-17bcff735d81" Name="win2019_restored251120T1625-RG0j@2021-02-04 00:09:17" />
</Links>
</Ref>
</EntityReferences>