Veeam Backup & Replication 13
REST API Reference
Related documents

Restore

The Restore section defines paths and operations for performing restore.

NOTE
In the current version, the REST API supports the following recovery operations:
  • Instant Recovery of a VMware vSphere VM to VMware vSphere
  • Entire VM restore of a VMware vSphere VM to VMware vSphere
  • Restore of disks that will be registered as First Class Disks (FCD) — a type of virtual disks that can be managed independent of any VM.

Get All VM Mounts

The HTTP GET request to the /api/v1/restore/instantRecovery/vmware/vm path allows you to get an array of VM mounts.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of mounts to skip.

limit
integer <int32>

Maximum number of mounts to return.

orderColumn
string (EInstantViVMRecoveryMountsFiltersOrderColumn)

Sorts mounts by one of the mount parameters.

Enum: "state" "name"
orderAsc
boolean

Sorts mounts in the ascending order by the orderColumn parameter.

stateFilter
string (EInstantRecoveryMountState)

Filters mounts by mount state.

Enum: "Failed" "Mounting" "Mounted" "Dismounting"
header Parameters
x-api-version
required
string
Default: 1.1-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses
200

OK

401

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

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/restore/instantRecovery/vmware/vm
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Start Instant Recovery
The HTTP POST request to the /api/v1/restore/instantRecovery/vmware/vm/ path allows you to start Instant Recovery of a VMware vSphere VM to VMware vSphere. You can recover a VM from the specified restore point to the original location with initial VM settings, or to any location but with different settings.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.1-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
objectRestorePointId
required
string <uuid> 
ID of the restore point.


 
type
required
string (EInstantVMRecoveryModeType) 
Restore mode.


 
required
object (SecureRestoreSpec) 
Secure restore settings.


 
VmTagsRestoreEnabled
boolean
If true, Veeam Backup & Replication restores tags that were assigned to the original VM, and assign them to the restored VM.


 
nicsEnabled
boolean
If true, the restored VM is connected to the network.


 
powerUp
boolean
If true, Veeam Backup & Replication starts the restored VM on the target host.


 
reason
string
Reason for restoring the VM.


 
Responses 
201
Instant Recovery to VMware vSphere has been started.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/restore/instantRecovery/vmware/vm
Request samples 
application/json
{
  • "objectRestorePointId": "267bb0bf-ecd3-4a69-add1-b9a94bf6cb3c",
  • "type": "OriginalLocation",
  • "VmTagsRestoreEnabled": true,
  • "secureRestore": {
    },
  • "nicsEnabled": true,
  • "powerUp": true,
  • "reason": "string"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "activityId": "bdfd0655-55e6-45e6-8bbc-6ed31d3820b5",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0
}
Get VM Mount
The HTTP GET request to the /api/v1/restore/instantRecovery/vmware/vm/{mountId} path allows you to get a VM mount that has the specified mountID.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount ID.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/restore/instantRecovery/vmware/vm/{mountId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
  • "state": "Failed",
  • "spec": {
    },
  • "vmName": "string",
  • "errorMessage": "string"
}
Stop VM Publishing
The HTTP POST request to the /api/v1/restore/instantRecovery/vmware/vm/{mountId}/unmount path allows you to stop publishing the recovered VM and remove it from the destination host.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount ID.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
VM has been unpublished.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/restore/instantRecovery/vmware/vm/{mountId}/unmount
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "activityId": "bdfd0655-55e6-45e6-8bbc-6ed31d3820b5",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0
}
Start VM Migration
The HTTP POST request to the /api/v1/restore/instantRecovery/vmware/vm/{mountId}/migrate path allows you to start VM migration from the specified mount.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount ID.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
required
object (VmwareObjectModel) 
VMware vSphere object.


 
object (VmwareObjectModel) 
VMware vSphere object.


 
object (VmwareObjectModel) 
VMware vSphere object.


 
object (VmwareObjectModel) 
VMware vSphere object.


 
sourceProxyIds
Array of strings <uuid> 
Array of source backup proxies.


 
targetProxyIds
Array of strings <uuid> 
Array of target backup proxies.


 
VeeamQMEnabled
boolean
If true, the Veeam Quick Migration mechanism is used. Otherwise, Veeam Backup & Replication will use VMware vMotion for migration.


 
DeleteSourceVmsFiles
boolean
If true, Veeam Backup & Replication will delete source VM files upon successful migration.


 
Responses 
200
VM Migration has been started. To check the progress, track the session state.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/restore/instantRecovery/vmware/vm/{mountId}/migrate
Request samples 
application/json
{
  • "destinationHost": {
    },
  • "resourcePool": {
    },
  • "folder": {
    },
  • "datastore": {
    },
  • "sourceProxyIds": [
    ],
  • "targetProxyIds": [
    ],
  • "VeeamQMEnabled": true,
  • "DeleteSourceVmsFiles": true
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "activityId": "bdfd0655-55e6-45e6-8bbc-6ed31d3820b5",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0
}
Start Entire VM Restore
The HTTP POST request to the /api/v1/restore/vmRestore/vmware/ path allows you to perform entire VM restore of a VMware vSphere VM to VMware vSphere. You can restore a VM from the specified restore point to the original location with initial VM settings, or to any location but with different settings.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.1-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
objectRestorePointId
required
string <uuid> 
ID of the restore point.


 
type
required
string (EEntireVMRestoreModeType) 
Restore mode.


 
object (RestoreProxySpec) 
Backup proxies for VM data transport.


 
object (SecureRestoreSpec) 
Secure restore settings.


 
powerUp
boolean
If true, Veeam Backup & Replication starts the restored VM on the target host.


 
reason
string
Reason for restoring the VM.


 
quickRollback
boolean
If true, Veeam Backup & Replication performs incremental restore.


 
Responses 
201
Restore session has been created. To check the progress, track the session state.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/restore/vmRestore/vmware
Request samples 
application/json
{
  • "objectRestorePointId": "267bb0bf-ecd3-4a69-add1-b9a94bf6cb3c",
  • "type": "OriginalLocation",
  • "restoreProxies": {
    },
  • "secureRestore": {
    },
  • "powerUp": true,
  • "reason": "string",
  • "quickRollback": true
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "activityId": "bdfd0655-55e6-45e6-8bbc-6ed31d3820b5",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0
}
Get All FCD Mounts
The HTTP GET request to the /api/v1/restore/instantRecovery/vmware/fcd path allows you to get an array of FCD mounts.


SecurityBearer 
Request 
query Parameters
skip
integer <int32> 
Number of mounts to skip.


 
limit
integer <int32> 
Maximum number of mounts to return.


 
orderColumn
string (EVmwareFcdInstantRecoveryMountsFiltersOrderColumn) 
Sorts mounts by one of the mount parameters.


 Enum: "state" "name"  
orderAsc
boolean
Sorts mounts in the ascending order by the orderColumn parameter.


 
stateFilter
string (EInstantRecoveryMountState) 
Filters mounts by mount state.


 Enum: "Failed" "Mounting" "Mounted" "Dismounting"  
header Parameters
x-api-version
required
string
 Default:  1.1-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/restore/instantRecovery/vmware/fcd
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Start Instant FCD Recovery
The HTTP POST request to the /api/v1/restore/instantRecovery/vmware/fcd/ path allows you to start Instant FCD Recovery from the restore point to the destination cluster.
Specify the destination cluster in the destinationCluster parameter of the request body as a model of the VMware vSphere object. For details on how to get the cluster model, see Get VMware vSphere Server Objects.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.1-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
objectRestorePointId
required
string <uuid> 
ID of the restore point.


 
required
object (VmwareObjectModel) 
VMware vSphere object.


 
required
Array of objects (VmwareFcdInstantRecoveryDiskSpec) 
Array of disks for restore.


 
object (VmwareFcdWriteCacheSpec) 
Write cache for recovered disks.


 
Responses 
201
Instant FCD Recovery has been started. To check the progress, track the session state.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/restore/instantRecovery/vmware/fcd
Request samples 
application/json
{
  • "objectRestorePointId": "267bb0bf-ecd3-4a69-add1-b9a94bf6cb3c",
  • "destinationCluster": {
    },
  • "disksMapping": [
    ],
  • "writeCache": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "activityId": "bdfd0655-55e6-45e6-8bbc-6ed31d3820b5",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0
}
Get FCD Mount
The HTTP GET request to the /api/v1/restore/instantRecovery/vmware/fcd/{mountId} path allows you to get information about the mounted vPower NFS datastore, such as restore session ID, mount state, instant FCD recovery settings and disks that will be recovered.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount ID.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/restore/instantRecovery/vmware/fcd/{mountId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
  • "state": "Failed",
  • "spec": {
    },
  • "errorMessage": "string",
  • "mountedDisks": [
    ]
}
Stop FCD Publishing
The HTTP POST request to the /api/v1/restore/instantRecovery/vmware/fcd/{mountId}/dismount path allows you to stop publishing the recovered FCDs and remove the disks from the datastore.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount ID.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
Disks has been unmounted. To check the progress, track the session state.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/restore/instantRecovery/vmware/fcd/{mountId}/dismount
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "activityId": "bdfd0655-55e6-45e6-8bbc-6ed31d3820b5",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0
}
Start FCD Migration
The HTTP POST request to the /api/v1/restore/instantRecovery/vmware/fcd/{mountId}/migrate path allows you to start migration of FCDs from the specified mount.
In the request body specify FCD migration configuration:
     
  • Disks for migration
    •  
  • Target datastore
    •  
  • Storage policy that will be applied to the migrated disks
 For details on how to get models of the datastore and storage policy, see Get VMware vSphere Server Objects.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount ID.


 
header Parameters
x-api-version
required
string
 Default:  1.1-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
required
object (VmwareObjectModel) 
VMware vSphere object.


 
mountedDiskNames
Array of strings
Array of disks that will be migrated to the targetDatastore associated with the storagePolicy.


 
object (VmwareObjectModel) 
VMware vSphere object.


 
Responses 
200
FCD Migration has been started. To check the progress, track the session state.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


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


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/restore/instantRecovery/vmware/fcd/{mountId}/migrate
Request samples 
application/json
{
  • "mountedDiskNames": [
    ],
  • "targetDatastore": {
    },
  • "storagePolicy": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "activityId": "bdfd0655-55e6-45e6-8bbc-6ed31d3820b5",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0
}