This is an archive version of the document. To get the most up-to-date information, see the current version.

Get Azure VM Restore Points

You can get a list of all restore points of an Azure VM available for a restore operation in Veeam Backup for Microsoft Azure.

Request

To retrieve a representation of all Azure VM restore points, send the HTTP GET request to the /restorePoints endpoint.

HTTP Request

GET https://<hostname>/api/v3/restorePoints

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit and the following query parameters:

Query Parameter

Value

Description

VirtualMachineId

string

Returns only restore points of an Azure VM with the specified ID. For more information, see Filter Parameters.

DiskId

string

Returns only restore points of a virtual disk with the specified ID. For more information, see Filter Parameters.

OnlyLatest

boolean

Defines whether Veeam Backup for Microsoft Azure must return only the latest restore point.

DataRetrievalStatuses

  • None
  • Retrieving
  • Retrieved

Returns only restore points with the specified retrieval status.

PointInTime

string($date-time)

Returns only restore points created at the specific date and time.

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a 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

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a representation of the /restorePoints collection. The RestorePointv3 schema is used for the collection representation.

Get Azure VM Restore PointsExample

The following request returns a full list of restore points.

Request:

GET https://51.11.247.127/api/v3/restorePoints

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "offset": 0,

 "limit": 200,

 "totalCount": 10,

 "results": [

   {

     "id": "047a1f81-b7fe-457b-90ce-531e465e2d7b",

     "pointInTime": "2020-11-29T18:00:15.247897Z",

     "backupSizeBytes": 0,

     "backupDestination": "Snapshot",

     "gfsFlags": "Daily",

     "jobSessionId": "3ac8d7fe-383d-42b9-9890-83a75e51ba7a",

     "usn": 142,

     "_embeddedResources": {},

     "_links": {

       "self": {

         "href": "https://51.11.247.127/api/v3/restorePoints/047a1f81-b7fe-457b-90ce-531e465e2d7b"

       },

       "BackupJob": {

         "href": "https://51.11.247.127/api/v3/jobSessions/3ac8d7fe-383d-42b9-9890-83a75e51ba7a"

       }

     }

   },

...

],

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v3/restorePoints?onlyLatest=False&offset=0&limit=200"

   }

 }

}