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

Get Recovery Location Data

You can get a representation of a recovery location with the specified ID.

Request

To retrieve a representation of a recovery location, send the HTTP GET request to the  /RecoveryLocations/{id} endpoint.

HTTP Request

GET https://<hostname>:<port>/api/v3/RecoveryLocations/{id}

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.

Accept

Optional

  • application/xml
  • text/json
  • application/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 200 response code.

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/xml
  • text/json
  • application/json

Identifies the media type of the response body message.

Response Body

In the response body, VAO returns a representation of the /RecoveryLocations/{id} resource. The RecoveryLocationInfo schema with subschemas used for the resource representation.

Get Recovery Location DataExample

The following example returns an entity representation of a recovery location with the ID 9f56721c-751f-4ff8-bf45-2f761453caff.

Request:

GET https://uwin2012r2.n.local:9898/api/v3/RecoveryLocations/9f56721c-751f-4ff8-bf45-2f761453caff

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "success": true,

 "data": {

   "cpuPressureThreshold": 0,

   "storagePressureThreshold": 81,

   "instantVmRecovery": true,

   "redirectDiskOperations": false,

   "preferBackupCopy": false,

   "migrateBetweenLocations": false,

   "storageGroups": [],

   "id": "9f56721c-751f-4ff8-bf45-2f761453caff",

   "type": "Restore",

   "name": "Original VM Location",

   "description": "Original location of source VM",

   "isOriginal": true,

   "useReIp": false,

   "useNetworkMapping": false,

   "computeGroups": [],

   "reIpRules": [],

   "networkMappingRules": [],

   "availability": "Available"

 }

}

I want to report a typo

There is a misspelling right here:

 

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