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

Validate Volume-Level Restore

You can can check if restore settings for the restore operation of an EC2 instance volume to a restore point with the specified ID are valid.

Request

To check if restore settings are valid, send the HTTP POST request to the /vmRestorePoints/{vmRestorePointId}/validateRestoreDisk endpoint. {vmRestorePointId} is a system ID assigned to the restore point of an EC2 instance in the Veeam Backup for AWS REST API.

HTTP Request

POST https://<hostname>:<port>/api/v1/vmRestorePoints/{vmRestorePointId}/validateRestoreDisk

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.

Content-Type

Required

application/json

Identifies a media type that is used in the body of the request.

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.

Request Body

Request Body

To validate restore settings for volume-level restore, use the DiskBulkRestoreOptions schema to send parameters in the request body.

Set the parameter values in the following format:

{

 "reason": "string",

 "amazonAccountId": "string($uuid)",

 "accessKey": "string",

 "secretKey": "string",

 "volumes": [

   {

     "diskId": "string",

     "name": "string"

   }

 ],

 "toAlternative": {

   "availabilityZoneId": "string($uuid)",

   "preserveEncryptionForVolumes": true/false,

   "encryptionKeyId": "string"

 }

}

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

If restore settings for the restore operation are valid, Veeam Backup for AWS does not return a response body, in other cases Veeam Backup for AWS returns the severity level and the error message.

Validate Volume-Level RestoreExample

The following request validates restore settings for the restore operation of the EC2 instance volume with the ID vol-07e0c86bf2f217dcf to a restore point with the ID d98f4d37-7874-4be1-9702-770078f5c9cd.

Request:

GET https://135.169.170.192:11005/api/v1/vmRestorePoints/d98f4d37-7874-4be1-9702-770078f5c9cd/validateRestoreDisk

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

Content-Type: application/json

 

Request Body:

{

 "amazonAccountId": "aa4928a2-2367-4a6b-a4a2-a6b4a825a0e3",

 "volumes": [

   {

     "diskId": "vol-07e0c86bf2f217dcf"

   }

 ]

}

 

Response:

200