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

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) Deprecated Obsolete parameter. Use the actionFilters parameter instead.
	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.
	Array of objects (Expression) Returns only specific items of a resource collection in the response. To learn how to use the `actionFilters` parameter, see the Veeam Recovery Orchestrator REST API Reference, section ActionFilters Parameter.

Responses

200

401

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

500

Internal server error.

get/api/v13.1/RecoveryLocations

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"total": 1,
"data": [{"id": "62deec4d-e77e-4daf-ba1d-ed898d228ae3",
"type": "Restore",
"name": "Dept01 RL",
"description": "Recovery location for dept01 VMs",
"isOriginal": false
}
]
}

Get VMware vSphere Recovery Location Data

The HTTP GET request to the /RecoveryLocations/Restore/{id} endpoint retrieves a representation of a VMware vSphere recovery location with the specified ID.

SecurityuserAuth

Request

path Parameters

required

string <uuid>

System ID assigned to a recovery location.

Responses

200

401

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

500

Internal server error.

get/api/v13.1/RecoveryLocations/Restore/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"computeGroups": [{"id": "e922cee9-f044-4c98-9ada-51364fb5db26",
"name": "cluster1",
"resourceType": "Compute",
"itemsCount": 1
}
],
"reIpRules": [{"id": "fda2d10a-dfcf-4add-ada9-120f68fe35bc",
"sourceIp": "172.17.52.*",
"sourceMask": "255.255.254.0",
"targetIp": "172.17.53.*",
"targetMask": "255.255.254.0",
"targetGateway": "172.17.53.1",
"preferredDns": "",
"alternateDns": "",
"description": "ReIp for group1",
"name": "172.17.52.* - 172.17.53.*",
"nameWasAutomaticallySet": true
}
],
"vCenterNetworkMappingRules": [{"id": "6554ec9d-359c-42d6-8951-f7c1703751e5",
"name": "rule1",
"nameWasAutomaticallySet": false,
"matchAnySourceNetwork": false,
"sourceNetworkVcId": 17,
"sourceNetworkVcName": "vc1.test.local",
"sourceNetworkDcId": 32,
"sourceNetworkId": "72c5cc45-37fb-4e9a-aeac-eff1258e0d51",
"sourceNetworkName": "network1",
"sourceNetworkIsRemoved": false,
"targetNetworkVcId": 17,
"targetNetworkVcName": "vc1.test.local",
"targetNetworkDcId": 32,
"targetNetworkId": "1f419ca4-eaf4-4aaf-ada0-9fdafde1e5ed",
"targetNetworkName": "network2",
"targetNetworkIsRemoved": false
}
],
"cpuPressureThreshold": 1,
"storagePressureThreshold": 1,
"instantVmRecovery": true,
"vbrServerId": "df630c31-4780-4e73-b434-6cf202d154be",
"repositoryRules": [{"repositoryId": "bd22b11c-16f0-4e9b-8618-706e2804de54"
}
],
"backupLocation": "Any",
"enforceDataSovereignty": true,
"storageGroups": [{"id": "eba4a8d3-fdac-4292-af58-85b1d6409a5a",
"name": "group1",
"resourceType": "Storage",
"itemsCount": 2
}
],
"physicalNetworkMappingRules": [{"id": "22e5b409-4503-4647-afe9-d9699d6f3f6c",
"name": "rule1",
"nameWasAutomaticallySet": false,
"matchAnySourceNetwork": false,
"ipAddress": "172.17.53.0",
"cidr": 24,
"targetNetworkVcId": 12,
"targetNetworkVcName": "vc1.test.local",
"targetNetworkDcId": 10,
"targetNetworkId": "ee02e086-16ab-4ee2-8545-f29958201407",
"targetNetworkName": "network1",
"targetNetworkIsRemoved": false
}
],
"id": "4862e7c9-2125-463a-b095-f87857cbcdd8",
"type": "Restore",
"name": "Dept01 RL",
"description": "Recovery location for dept01 VMs",
"isOriginal": false
}

Get Storage Recovery Location Data

The HTTP GET request to the /RecoveryLocations/Storage/{id} endpoint retrieves a representation of a storage recovery location with the specified ID.

SecurityuserAuth

Request

path Parameters

required

string <uuid>

System ID assigned to a recovery location.

Responses

200

401

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

500

Internal server error.

get/api/v13.1/RecoveryLocations/Storage/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"computeGroups": [{"id": "e922cee9-f044-4c98-9ada-51364fb5db26",
"name": "cluster1",
"resourceType": "Compute",
"itemsCount": 1
}
],
"reIpRules": [{"id": "fda2d10a-dfcf-4add-ada9-120f68fe35bc",
"sourceIp": "172.17.52.*",
"sourceMask": "255.255.254.0",
"targetIp": "172.17.53.*",
"targetMask": "255.255.254.0",
"targetGateway": "172.17.53.1",
"preferredDns": "",
"alternateDns": "",
"description": "ReIp for group1",
"name": "172.17.52.* - 172.17.53.*",
"nameWasAutomaticallySet": true
}
],
"networkMappingRules": [{"id": "6554ec9d-359c-42d6-8951-f7c1703751e5",
"name": "rule1",
"nameWasAutomaticallySet": false,
"matchAnySourceNetwork": false,
"sourceNetworkVcId": 17,
"sourceNetworkVcName": "vc1.test.local",
"sourceNetworkDcId": 32,
"sourceNetworkId": "72c5cc45-37fb-4e9a-aeac-eff1258e0d51",
"sourceNetworkName": "network1",
"sourceNetworkIsRemoved": false,
"targetNetworkVcId": 17,
"targetNetworkVcName": "vc1.test.local",
"targetNetworkDcId": 32,
"targetNetworkId": "1f419ca4-eaf4-4aaf-ada0-9fdafde1e5ed",
"targetNetworkName": "network2",
"targetNetworkIsRemoved": false
}
],
"vendor": "NetApp",
"vCenterId": "a1b2c3d4-e5f6-4780-1234-56789abcdef0",
"vCenterName": "vcenter1.test.local",
"datacenterId": "12345678-90ab-cdef-1234-567890abcdef",
"datacenterName": "Datacenter1",
"storageSystems": [{"id": "9abcdef0-1234-5678-90ab-cdef12345678",
"name": "StorageSystem1",
"svmName": "SVM1",
"order": 1
}
],
"id": "4862e7c9-2125-463a-b095-f87857cbcdd8",
"type": "Storage",
"name": "Dept01 RL",
"description": "Recovery location for dept01 VMs",
"isOriginal": false
}

Get Microsoft Azure Recovery Location Data

The HTTP GET request to the /RecoveryLocations/Azure/{id} endpoint retrieves a representation of a Microsoft Azure recovery location with the specified ID.

SecurityuserAuth

Request

path Parameters

required

string <uuid>

System ID assigned to a recovery location.

Responses

200

401

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

500

Internal server error.

get/api/v13.1/RecoveryLocations/Azure/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"backupLocation": "Any",
"vbrServerId": "df630c31-4780-4e73-b434-6cf202d154be",
"computeAccountId": "aabbccdd-eeff-0011-2233-445566778899",
"subscriptionId": "11223344-5566-7788-99aa-bbccddeeff00",
"regionType": "Global",
"regionId": "99887766-5544-3322-1100-ffeeddccbbaa",
"resourceGroupId": "66778899-aabb-ccdd-eeff-001122334455",
"hardwareRules": [{"machineTypeFamilyId": "55554444-3333-2222-1111-0000ffffffff",
"machineTypeFamilyName": "Dv2 Series",
"diskType": "StandardHDD",
"isPremiumStorageSupported": true,
"order": 1,
"machineTypeFamilyMaxCpu": 64,
"machineTypeFamilyMaxRam": 256,
"machineTypeFamilyMaxDisks": 16
}
],
"repositoryRules": [{"repositoryId": "bd22b11c-16f0-4e9b-8618-706e2804de54"
}
],
"proxyIds": ["cafebabe-0000-1111-2222-333344445555",
"deadbeef-6666-7777-8888-9999aaaabbbb"
],
"virtualNetworkMappingRules": [{"id": "6554ec9d-359c-42d6-8951-f7c1703751e5",
"name": "rule1",
"sourceNetworkVcId": 17,
"sourceNetworkVcName": "vc1.test.local",
"sourceNetworkDcId": 32,
"sourceNetworkId": "72c5cc45-37fb-4e9a-aeac-eff1258e0d51",
"sourceNetworkName": "network1",
"sourceNetworkIsRemoved": false,
"targetNetworkId": "1f419ca4-eaf4-4aaf-ada0-9fdafde1e5ed",
"targetNetworkName": "network2",
"targetSubnetId": "2233bbaa-4455-ddcc-6677-ffee88990011",
"targetSubnetName": "subnet1",
"targetSecurityGroupId": "1122aabb-3344-ccdd-5566-eeff77889900",
"targetSecurityGroupName": "sg1",
"nameWasAutomaticallySet": false,
"matchAnySourceNetwork": false
}
],
"physicalNetworkMappingRules": [{"id": "22e5b409-4503-4647-afe9-d9699d6f3f6c",
"name": "rule1",
"nameWasAutomaticallySet": false,
"ipAddress": "172.17.53.0",
"cidr": 24,
"targetSubnetId": "3344ccdd-5566-eeff-7788-99aabbccddee",
"targetSubnetName": "subnet1",
"targetSecurityGroupId": "4455ddee-6677-ff00-8899-001122334455",
"targetSecurityGroupName": "sg1",
"targetNetworkId": "ee02e086-16ab-4ee2-8545-f29958201407",
"targetNetworkName": "network1",
"matchAnySourceNetwork": false
}
],
"hyperVNetworkMappingRules": [{"id": "6554ec9d-359c-42d6-8951-f7c1703751e5",
"name": "rule1",
"nameWasAutomaticallySet": false,
"sourceNetworkScVmmId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"sourceNetworkScVmmName": "scvmm1.test.local",
"sourceNetworkClusterId": "b1c2d3e4-6789-0abc-def1-234567890abc",
"sourceNetworkClusterName": "cluster1",
"sourceNetworkId": "72c5cc45-37fb-4e9a-aeac-eff1258e0d51",
"sourceNetworkName": "network1",
"sourceNetworkIsRemoved": false,
"sourceNetworkIsClustered": true,
"targetNetworkId": "1f419ca4-eaf4-4aaf-ada0-9fdafde1e5ed",
"targetNetworkName": "network2",
"targetSubnetId": "2233bbaa-4455-ddcc-6677-ffee88990011",
"targetSubnetName": "subnet1",
"targetSecurityGroupId": "1122aabb-3344-ccdd-5566-eeff77889900",
"targetSecurityGroupName": "sg1",
"matchAnySourceNetwork": false
}
],
"isolatedNetworkId": "12344321-4321-4321-4321-123443211234",
"isolatedSubnetId": "abcddcba-dcba-dcba-dcba-abcddcbaabcd",
"id": "4862e7c9-2125-463a-b095-f87857cbcdd8",
"type": "Cloud",
"name": "Dept01 RL",
"description": "Recovery location for dept01 VMs",
"isOriginal": false
}

Get Microsoft Hyper-V Recovery Location Data

The HTTP GET request to the /RecoveryLocations/HyperV/{id} endpoint retrieves a representation of a Microsoft Hyper-V recovery location with the specified ID.

SecurityuserAuth

Request

path Parameters

required

string <uuid>

System ID assigned to a recovery location.

Responses

200

401

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

500

Internal server error.

get/api/v13.1/RecoveryLocations/HyperV/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"backupLocation": "Any",
"enforceDataSovereignty": true,
"instantVmRecovery": true,
"scVmmId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"scVmmName": "scvmm1.test.local",
"clusterId": "b1c2d3e4-6789-0abc-def1-234567890abc",
"clusterName": "cluster1",
"storages": [{"id": "9abcdef0-1234-5678-90ab-cdef12345678",
"path": "CSV1",
"isRemoved": false
}
],
"vmNetworkMappingRules": [{"id": "6554ec9d-359c-42d6-8951-f7c1703751e5",
"name": "rule1",
"nameWasAutomaticallySet": false,
"sourceNetworkVcId": 17,
"sourceNetworkVcName": "vc1.test.local",
"sourceNetworkDcId": 32,
"sourceNetworkId": "72c5cc45-37fb-4e9a-aeac-eff1258e0d51",
"sourceNetworkName": "network1",
"sourceNetworkIsRemoved": false,
"targetNetworkScVmmId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"targetNetworkScVmmName": "scvmm1.test.local",
"targetNetworkClusterId": "b1c2d3e4-6789-0abc-def1-234567890abc",
"targetNetworkClusterName": "cluster1",
"targetNetworkId": "1f419ca4-eaf4-4aaf-ada0-9fdafde1e5ed",
"targetNetworkName": "network2",
"targetNetworkIsRemoved": false,
"targetNetworkIsClustered": true,
"matchAnySourceNetwork": false
}
],
"hyperVNetworkMappingRules": [{"id": "22e5b409-4503-4647-afe9-d9699d6f3f6c",
"name": "rule1",
"nameWasAutomaticallySet": false,
"sourceNetworkScVmmId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"sourceNetworkScVmmName": "scvmm1.test.local",
"sourceNetworkClusterId": "b1c2d3e4-6789-0abc-def1-234567890abc",
"sourceNetworkClusterName": "cluster1",
"sourceNetworkId": "72c5cc45-37fb-4e9a-aeac-eff1258e0d51",
"sourceNetworkName": "network1",
"sourceNetworkIsRemoved": false,
"sourceNetworkIsClustered": true,
"targetNetworkScVmmId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"targetNetworkScVmmName": "scvmm1.test.local",
"targetNetworkClusterId": "b1c2d3e4-6789-0abc-def1-234567890abc",
"targetNetworkClusterName": "cluster1",
"targetNetworkId": "ee02e086-16ab-4ee2-8545-f29958201407",
"targetNetworkName": "network1",
"targetNetworkIsRemoved": false,
"targetNetworkIsClustered": true,
"matchAnySourceNetwork": false
}
],
"hvConnectionType": "ScVmm",
"vbrServerId": "df630c31-4780-4e73-b434-6cf202d154be",
"repositoryRules": [{"repositoryId": "bd22b11c-16f0-4e9b-8618-706e2804de54"
}
],
"id": "4862e7c9-2125-463a-b095-f87857cbcdd8",
"type": "HyperV",
"name": "Dept01 RL",
"description": "Recovery location for dept01 VMs",
"isOriginal": false
}

Create Recovery Location for Standalone Hyper-V Host

The HTTP POST request to the /RecoveryLocations/HyperV/DirectHost endpoint creates a new Microsoft Hyper-V recovery location for restoring VMware VMs to a standalone Hyper-V host.

SecurityuserAuth

Request

Request Body schema: application/json

directHostId required	string <uuid> System ID assigned to the Microsoft Hyper-V host that is used as a recovery location.
name required	string or null Name of the recovery location.
required	object (DirectHostVmNetworkMappingRuleInfo)
description	string or null Description of the recovery location.
backupLocation	string Restore point source. Enum: "Any" "Primary" "BackupCopies" "SobrCapacityTier" "Unknown"
enforceDataSovereignty	boolean Defines whether VMs will be recovered across different locations in the Veeam Backup & Replication server when running recovery plans.
instantVmRecovery	boolean Defines whether all processed VMs will be restored using the Instant VM Recovery feature.

Responses

204

No Content

401

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

500

Internal server error.

post/api/v13.1/RecoveryLocations/HyperV/DirectHost

Request samples

application/json

{"name": "string",
"description": "string",
"directHostId": "7f7162b6-a88b-4262-a0ca-d5554c9dfaaa",
"vmNetworkMappingRule": {"name": "string",
"targetNetworkId": "5c0402d3-4284-4c4d-8df7-54de69fad331"
},
"backupLocation": "Any",
"enforceDataSovereignty": true,
"instantVmRecovery": true
}

Delete Recovery Location

The HTTP DELETE request to the /RecoveryLocations/{id} endpoint deletes a recovery location with the specified ID.

SecurityuserAuth

Request

path Parameters

required

string <uuid>

System ID assigned to a recovery location.

Responses

204

No Content

401

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

500

Internal server error.

delete/api/v13.1/RecoveryLocations/{id}

Request samples

curl
Python
JavaScript
C#
Go