Veeam Backup & Replication 10
Veeam RESTful API Reference
Related documents

(GET) /restorePoints/{ID}

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

Request

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

HTTP Request

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

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 restore point resource, for example: urn:veeam:RestorePoint:bf0542a7-baea-41fa-baec-12e76043d0e1

True

True

Name

String

Name of the restore point, for example: Aug 26 2013 7:57AM.

True

True

CreationTime

DateTime

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

True

True

BackupUid

URN

ID of the VM backup parent to the restore point resource.

True

True

BackupName

String

Name of the backup parent to the restore point resource.

True

True

BackupServerUid

URN

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

True

True

BackupServerName

String

Name of the Veeam backup server on which the 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 /restorePoints/{ID} resource.

Example

A sample request below returns a restore point having ID e4108a85-4532-4b1a-b1b6-3c1faba1c4de.

Request:

GET https://localhost:9398/api/restorePoints/e4108a85-4532-4b1a-b1b6-3c1faba1c4de

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="RestorePointReference" Href="https://localhost:9398/api/restorePoints/e4108a85-4532-4b1a-b1b6-3c1faba1c4de" Name="Oct  6 2014  1:06PM" UID="urn:veeam:RestorePoint:e4108a85-4532-4b1a-b1b6-3c1faba1c4de">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.tech.local" />
   <Link Rel="Up" Type="BackupReference" Href="https://localhost:9398/api/backups/ef3bd23f-c284-44bc-abcb-1e03e150f2c6" Name="Webserver Backup" />
   <Link Rel="Alternate" Type="RestorePoint" Href="https://localhost:9398/api/restorePoints/e4108a85-4532-4b1a-b1b6-3c1faba1c4de?format=Entity" Name="Oct  6 2014  1:06PM" />
   <Link Rel="Down" Type="VmRestorePointReferenceList" Href="https://localhost:9398/api/restorePoints/e4108a85-4532-4b1a-b1b6-3c1faba1c4de/vmRestorePoints" />
   <Link Rel="Down" Type="VAppRestorePointReferenceList" Href="https://localhost:9398/api/restorePoints/e4108a85-4532-4b1a-b1b6-3c1faba1c4de/vAppRestorePoints" />
   <Link Rel="Related" Type="RestorePointReferenceList" Href="https://localhost:9398/api/restorePoints/e4108a85-4532-4b1a-b1b6-3c1faba1c4de/backupFiles" />
 </Links>
</EntityRef>

 

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VVeeam Backup Enterprise Manager GuideVeeam Agent Management GuideVeeam Cloud Connect GuideVeeam Explorers User GuideVeeam Plug-ins for Enterprise Applications GuideVeeam PowerShell ReferenceVeeam Explorers PowerShell ReferenceVeeam RESTful API ReferenceRequired Permissions for VMware vSphereQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Backup for AWS DocumentationVeeam Backup for Microsoft Azure DocumentationVeeam Backup for Nutanix AHV User GuideVeeam Backup for Microsoft Office 365 DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

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