Veeam Recovery Orchestrator 7.2
REST API Reference
Related documents

RecoveryLocations

The /RecoveryLocations resource collection represents all recovery locations configured in Orchestrator. The collection includes resources which represent individual recovery locations and have specific system IDs.

NOTE
A range of data available to a client in the Orchestrator REST API depends on permissions of the account under which the client is currently logged in.

Get Collection of Recovery Locations

The HTTP GET request to the /RecoveryLocations endpoint retrieves a list of all configured recovery locations in Orchestrator.

SecurityuserAuth or clientAuth
Request
query Parameters
start
integer <int32>

Excludes the first N items of a resource collection from the response.

limit
integer <int32>

Specifies the maximum number of items of a resource collection to return in a response.

Array of objects (Expression)

Returns only specific items of a resource collection in the response. To learn how to use the filter parameter, see the Veeam Recovery Orchestrator REST API Reference, section Filter Parameter.

Array of objects (SortQuery)

Specifies the order of items of a resource collection in the response. To learn how to use the sort parameter, see the Veeam Recovery Orchestrator REST API Reference, section Sort Parameter.

Responses
200

OK

401

Unauthorized request. The authorization header has been expected but not found (or found but expired).

500

Internal server error.

get/api/v7.21/RecoveryLocations
Request samples 
Response samples 
{
  • "total": 1,
  • "data": [
    ]
}
Get Recovery Location Data
The HTTP GET request to the /RecoveryLocations/{id} endpoint retrieves a representation of a recovery location with the specified ID.


SecurityuserAuth or clientAuth 
Request 
path Parameters
id
required
string <uuid> 
System ID assigned to a recovery location.


 
Responses 
200
OK


401
Unauthorized request. The authorization header has been expected but not found (or found but expired).


500
Internal server error.


get/api/v7.21/RecoveryLocations/{id}
Request samples 
Response samples 
{
  • "computeGroups": [
    ],
  • "reIpRules": [
    ],
  • "networkMappingRules": [
    ],
  • "cpuPressureThreshold": 1,
  • "storagePressureThreshold": 1,
  • "instantVmRecovery": true,
  • "recoverAgentBackups": false,
  • "recoverVmBackups": false,
  • "preferBackupCopy": false,
  • "enforceDataSovereignty": true,
  • "storageGroups": [
    ],
  • "physicalNetworkMappingRules": [
    ],
  • "id": "4862e7c9-2125-463a-b095-f87857cbcdd8",
  • "type": "Restore",
  • "name": "Dept01 RL",
  • "description": "Recovery location for dept01 VMs",
  • "isOriginal": false
}