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

Get Restore Session Data

You can get data on EC2 instances restored during a session with the specified ID.

Request

To retrieve a list of restored EC2 instances, send the HTTP GET request to the /session/{restoreSessionId}/restoredItems endpoint. {restoreSessionId} is a system ID assigned to the session of restore activity in the Veeam Backup for AWS REST API.

HTTP Request

GET https://<hostname>:<port>/api/v1/session/{restoreSessionId}/restoredItems

Query Parameters

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

Query Parameter

Value

Description

Sort

  • nameAsc
  • nameDesc
  • regionAsc
  • regionDesc

Specifies the order of items in the response. For more information, see Sort Parameter.

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 collection of restored EC2 instances. The RestoredItem schema is used for the resource representation.

Get Restore Session DataExample

The following request returns data on EC2 instances restored during a session with the ID 6218b379-b011-4736-bc19-bb59519b094e.

Request:

GET https://135.169.170.192:11005/api/v1/sessions/6218b379-b011-4736-bc19-bb59519b094e/restoredItems

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

200

 

Response Body:

{

 "totalCount": 1,

 "results": [

   {

     "name": "oz-Tgt-01",

     "status": "Succeeded",

     "regionName": "US West (N. California) (us-west-1)",

     "_embedded": {

       "virtualMachine": {

         "method": "GET",

         "rel": "self",

         "href": "https://135.169.170.192:11005/api/v1/virtualMachines/be471476-66f4-4d2f-86c7-cffe34adf4cc"

       },

       "region": {

         "method": "GET",

         "rel": "self",

         "href": "https://135.169.170.192:11005/api/v1/cloudInfrastructure/regions/cd1fd042-c7bd-4ebe-b644-536e49fb65a2"

       }

     }

   }

 ],

 "_links": [

   {

     "method": "GET",

     "rel": "self",

     "href": "https://135.169.170.192:11005/api/v1/sessions/6218b379-b011-4736-bc19-bb59519b094e/restoredItems"

   }

 ]

}