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

Get EC2 Instance Restore Points

You can get a list of all restore points of an EC2 instances available for a restore operation in Veeam Backup for AWS.

Request

To retrieve a representation of all EC2 instance restore points, send the HTTP GET request to the /vmRestorePoints endpoint.

HTTP Request

GET https://<hostname>:<port>/api/v1/vmRestorePoints

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 EC2 instance with the specified ID. For more information, see Filter Parameters.

Request Headers

The request contains the following headers.

Header	Required/Optional	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.
x-api-version	Required	1.0-rev0	Specifies the current revision of the Veeam Backup for AWS REST API.
Accept	Optional	application/json application/problem+json	Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Response

The server returns the following response to the client.

Response Code

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 AWS returns a representation of the /vmRestorePoints collection for the specified EC2 instance. The VmRestorePoint schema is used for the collection representation.

Get EC2 Instance Restore Points Example

The following request returns a full list of restore points for an EC2 instance with the ID d7b9e26d-1980-4dbb-baf3-5534fe5c8dd8.

Request:

GET https://135.169.170.192:11005/api/v1/vmRestorePoints?VirtualMachineId=d7b9e26d-1980-4dbb-baf3-5534fe5c8dd8

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

Response:

200

Response Body:

{

"totalCount": 3,

"results": [

{

"jobType": "Replica",

"id": "267e0938-6640-49b9-a6c3-c3b6942214ab",

"backupId": "65affc5f-0860-4d13-b880-01489d90bfe5",

"pointInTime": "2020-06-15T18:02:24.35",

"backupSizeBytes": 28991029248,

"volumes": [

{

"type": "Gp2",

"diskId": "vol-0da493e238e9b5d8c",

"backupSizeBytes": 9,

"iops": 100,

"name": "volume01",

"device": "/dev/sdf",

"encryptionKey": "",

"encryptionKeyName": ""

{

"type": "Gp2",

"diskId": "vol-03c2a8c7698ed7803",

"backupSizeBytes": 8,

"iops": 100,

"name": "volume02",

"device": "/dev/sda1",

"encryptionKey": "",

"encryptionKeyName": ""

{

"type": "Gp2",

"diskId": "vol-020fc7e075ab7a9ff",

"backupSizeBytes": 10,

"iops": 100,

"name": "win2016",

"device": "/dev/sdd",

"encryptionKey": "",

"encryptionKeyName": ""

}

"regionId": "457658a7-3b87-4d1e-9734-1839937b54fc",

"availabilityZoneId": "888f471b-2c81-4083-beb6-c76e5df20616",

"_links": [

{

"method": "GET",

"rel": "self",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/267e0938-6640-49b9-a6c3-c3b6942214ab"

{

"method": "POST",

"rel": "ValidateRestoreDisk",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/267e0938-6640-49b9-a6c3-c3b6942214ab/validateRestoreDisk"

{

"method": "POST",

"rel": "RestoreDisk",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/267e0938-6640-49b9-a6c3-c3b6942214ab/restoreDisk"

{

"method": "POST",

"rel": "ValidateRestoreVm",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/267e0938-6640-49b9-a6c3-c3b6942214ab/validateRestoreVm"

{

"method": "POST",

"rel": "RestoreVm",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/267e0938-6640-49b9-a6c3-c3b6942214ab/restoreVm"

}

]

{

"jobType": "Replica",

"id": "3dca5517-f0ed-4ba9-a900-184ffa13733c",

"backupId": "65affc5f-0860-4d13-b880-01489d90bfe5",

"pointInTime": "2020-06-15T12:01:33.259",

"backupSizeBytes": 28991029248,

"volumes": [

{

"type": "Gp2",

"diskId": "vol-0e33aacd37a7d134a",

"backupSizeBytes": 9,

"iops": 100,

"name": "volume01",

"device": "/dev/sdf",

"encryptionKey": "",

"encryptionKeyName": ""

{

"type": "Gp2",

"diskId": "vol-0dbe6a7783bebafe2",

"backupSizeBytes": 8,

"iops": 100,

"name": "volume02",

"device": "/dev/sda1",

"encryptionKey": "",

"encryptionKeyName": ""

{

"type": "Gp2",

"diskId": "vol-05be89c2359f32091",

"backupSizeBytes": 10,

"iops": 100,

"name": "win2016",

"device": "/dev/sdd",

"encryptionKey": "",

"encryptionKeyName": ""

}

"regionId": "457658a7-3b87-4d1e-9734-1839937b54fc",

"availabilityZoneId": "888f471b-2c81-4083-beb6-c76e5df20616",

"_links": [

{

"method": "GET",

"rel": "self",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/3dca5517-f0ed-4ba9-a900-184ffa13733c"

{

"method": "POST",

"rel": "ValidateRestoreDisk",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/3dca5517-f0ed-4ba9-a900-184ffa13733c/validateRestoreDisk"

{

"method": "POST",

"rel": "RestoreDisk",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/3dca5517-f0ed-4ba9-a900-184ffa13733c/restoreDisk"

{

"method": "POST",

"rel": "ValidateRestoreVm",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/3dca5517-f0ed-4ba9-a900-184ffa13733c/validateRestoreVm"

{

"method": "POST",

"rel": "RestoreVm",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/3dca5517-f0ed-4ba9-a900-184ffa13733c/restoreVm"

}

]

{

"jobType": "Replica",

"id": "d00c4d3c-8284-4607-bede-2a4f4768f3ec",

"backupId": "65affc5f-0860-4d13-b880-01489d90bfe5",

"pointInTime": "2020-06-16T12:02:20.285",

"backupSizeBytes": 28991029248,

"volumes": [

{

"type": "Gp2",

"diskId": "vol-0da493e238e9b5d8c",

"backupSizeBytes": 9,

"iops": 100,

"name": "volume01",

"device": "/dev/sdf",

"encryptionKey": "",

"encryptionKeyName": ""

{

"type": "Gp2",

"diskId": "vol-03c2a8c7698ed7803",

"backupSizeBytes": 8,

"iops": 100,

"name": "volume02",

"device": "/dev/sda1",

"encryptionKey": "",

"encryptionKeyName": ""

{

"type": "Gp2",

"diskId": "vol-020fc7e075ab7a9ff",

"backupSizeBytes": 10,

"iops": 100,

"name": "win2016",

"device": "/dev/sdd",

"encryptionKey": "",

"encryptionKeyName": ""

}

"regionId": "457658a7-3b87-4d1e-9734-1839937b54fc",

"availabilityZoneId": "888f471b-2c81-4083-beb6-c76e5df20616",

"_links": [

{

"method": "GET",

"rel": "self",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/d00c4d3c-8284-4607-bede-2a4f4768f3ec"

{

"method": "POST",

"rel": "ValidateRestoreDisk",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/d00c4d3c-8284-4607-bede-2a4f4768f3ec/validateRestoreDisk"

{

"method": "POST",

"rel": "RestoreDisk",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/d00c4d3c-8284-4607-bede-2a4f4768f3ec/restoreDisk"

{

"method": "POST",

"rel": "ValidateRestoreVm",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/d00c4d3c-8284-4607-bede-2a4f4768f3ec/validateRestoreVm"

{

"method": "POST",

"rel": "RestoreVm",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints/d00c4d3c-8284-4607-bede-2a4f4768f3ec/restoreVm"

}

]

}

"_links": [

{

"method": "GET",

"rel": "self",

"href": "https://135.169.170.192:11005/api/v1/vmRestorePoints?VirtualMachineId=d7b9e26d-1980-4dbb-baf3-5534fe5c8dd8"

}

]

}