(GET) /vAppReplicaPoints/{ID}

Returns a resource representation of the vApp replica restore point having the specified ID.

Request

To get a vApp replica restore point, you need to send the GET HTTP request to the URL of the /vAppReplicaPoints/{ID} resource.

HTTP Request

GET https://<Enterprise-Manager>:9398/api/vmReplicaPoints/{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:

  • 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.

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 vApp replica point resource.

True

True

Name

String

Name of the vApp replica point, for example: vApp01@2021-02-04 00:08:35.

True

True

vAppDisplayName

String

Display name of the vApp for which the restore point has been created.

True

True

CreationTime

DateTime

Date and time when the restore point was created. The parameter accepts only UTC-formatted DateTime values.

True

True

vAppName

String

Name of the vApp for which the restore point has been created.

True

True

Type

String

Type of the vApp replica point. Possible values:

  • Full
  • ReverseIncrement
  • Increment
  • Snapshot

True

True

Algorithm

String

Replication method used to create the restore point. Possible values:

  • Full
  • ReversedIncremental
  • Incremental
  • SyntheticFull

True

True

ReplicaUid

URN

ID of the vApp replica parent to the vApp replica point resource.

True

True

ReplicaName

String

Name of the vApp replica parent to the vApp replica point resource.

True

True

BackupServerUid

URN

ID of the backup server where the vApp replica restore point has been created.

True

True

BackupServerName

String

Name of the backup server where the vApp replica restore point has been created.

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:

  • application/xml
  • application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /vAppReplicaPoints/{ID} resource.

Example

The example below returns an entity resource representation of the vApp replica restore point having ID dc01c979-5f6a-409c-bcc2-c3c6ddf439b3:

Request:

GET https://localhost:9398/api/vAppReplicaPoints/dc01c979-5f6a-409c-bcc2-c3c6ddf439b3?format=Entity

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<VAppReplicaPoint xmlns="http://www.veeam.com/ent/v1.0" Type="VAppReplicaPoint" Href="https://localhost:9398/api/vAppReplicaPoints/dc01c979-5f6a-409c-bcc2-c3c6ddf439b3?format=Entity" Name="vApp01@2021-02-04 00:08:35" UID="urn:veeam:VAppReplicaPoint:dc01c979-5f6a-409c-bcc2-c3c6ddf439b3" VAppDisplayName="vApp01">
 <Links>
   <Link Rel="Failover" Href="https://localhost:9398/api/vAppReplicaPoints/dc01c979-5f6a-409c-bcc2-c3c6ddf439b3?action=failover" />
   <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="VAppReplicaPointReference" Href="https://localhost:9398/api/vAppReplicaPoints/dc01c979-5f6a-409c-bcc2-c3c6ddf439b3" 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>
 <CreationTimeUTC>2021-02-04T00:08:35.343Z</CreationTimeUTC>
 <VAppName>vApp01</VAppName>
 <Algorithm>Full</Algorithm>
 <PointType>Snapshot</PointType>
</VAppReplicaPoint>

 

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.