Help Center
Choose product document...
Veeam Backup & Replication 9.5
RESTful API Reference

(GET) /vmRestorePoints/{ID}

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

Request

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

HTTP Request

GET http://<Enterprise-Manager>:9399/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. To learn more, see Authentication and Security.

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 VM backup point resource.

True

True

Name

String

Name of the VM backup restore point, for example: sql01-hv@2013-08-24 05:03:25.

True

True

CreationTime

DateTime

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

True

True

Type

String

Type of the VM backup restore point. Possible values:

  • Full
  • Increment
  • ReverseIncrement

True

True

Algorithm

String

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

  • Full
  • ReversedIncremental
  • Incremental
  • SyntheticFull

True

True

RestorePointId

URN

ID of the restore point.

True

True

RestorePointName

String

Name of the restore point.

True

True

VmDisplayName

String

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

True

True

BackupServerUid

URN

ID of the Veeam backup server on which the VM backup restore point has been created.

True

True

BackupServerName

String

Name of the Veeam backup server on which the VM backup 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 Success.

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

Response Body

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

Example

The example below returns a restore point having ID 5fa68dec-cad0-47bc-bc33-0fe18b5d5e4d for the sql02 VM:

Request:

GET http://localhost:9399/api/vmRestorePoints/5fa68dec-cad0-47bc-bc33-0fe18b5d5e4d

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="VmRestorePointReference" Href="http://localhost:9399/api/vmRestorePoints/5fa68dec-cad0-47bc-bc33-0fe18b5d5e4d" Name="sql02@2014-10-13 09:52:41" UID="urn:veeam:VmRestorePoint:5fa68dec-cad0-47bc-bc33-0fe18b5d5e4d">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
   <Link Rel="Up" Type="RestorePointReference" Href="http://localhost:9399/api/restorePoints/09a3bd4d-7d34-47f2-89e4-b050841dd393" Name="Oct 13 2014  9:51AM" />
   <Link Rel="Alternate" Type="VmRestorePoint" Href="http://localhost:9399/api/vmRestorePoints/5fa68dec-cad0-47bc-bc33-0fe18b5d5e4d?format=Entity" Name="sql02@2014-10-13 09:52:41" />
 </Links>
</EntityRef>

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation