Veeam Backup & Replication 13
REST API Reference
Related documents

Restore

The Restore section defines operations for performing restore.

NOTE
In this version, the REST API supports the following recovery operations:
  • Instant Recovery to VMware vSphere
  • Instant Recovery to Microsoft Hyper-V
  • Instant Recovery of Microsoft Windows and Linux machine backups to Microsoft Azure
  • Instant File Share Recovery to the original or another location
  • Entire VM restore of a VMware vSphere VM backup to VMware vSphere
  • Entire VM restore of a Microsoft Hyper-V VM backup to Microsoft Hyper-V
  • Entire VM restore of a VMware Cloud Director VM backup to VMware Cloud Director
  • Restore of an entire file share, bucket or container backup to the original or another location
  • Restore of disk backups that will be registered as First Class Disks (FCD) — a type of virtual disks that can be managed independent of any VM
  • File restore from a backup or replica of a Microsoft Windows or Linux machine
  • File restore from an unstructured data backup
  • Microsoft Entra ID item restore
  • Microsoft Entra ID audit log restore

Restore Entire File Share

The HTTP POST request to the /api/v1/restore/unstructuredData/fileShare endpoint restores an entire file share to the original or another location.

Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev2

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

Request Body schema: application/json
required
restorePointId
required
string <uuid>

Restore point ID. To get the ID, run the Get All Restore Points request.

object (UnstructuredDataShareRestoreDestinationModel)

Target for restoring entire file share.

object (UnstructuredDataShareRestoreOptionsModel)

Restore options for restoring entire file share.

Responses
201

A 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/unstructuredData/fileShare
Request samples
application/json
{
  • "restorePointId": "9f469cdc-100a-4bba-9d0b-5c5411517808",
  • "destination": {
    },
  • "restoreOptions": {
    }
}
Response samples
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}

Restore Entire Object Storage Bucket or Container

The HTTP POST request to the /api/v1/restore/unstructuredData/objectStorage endpoint restores an entire object storage bucket or container.

Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev2

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

Request Body schema: application/json
required
restorePointId
required
string <uuid>

Restore point ID. To get the ID, run the Get All Restore Points request.

object (UnstructuredDataOSRestoreDestinationModel)

Target for restoring entire object storage bucket or container.

object (UnstructuredDataOSRestoreOptionsModel)

Restore options for restoring entire object storage bucket or container.

Responses
201

A 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/unstructuredData/objectStorage
Request samples
application/json
{
  • "restorePointId": "9f469cdc-100a-4bba-9d0b-5c5411517808",
  • "destination": {
    },
  • "restoreOptions": {
    }
}
Response samples
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}

Get All Mount Points for Instant File Share Recovery

The HTTP GET request to the /api/v1/restore/instantRecovery/unstructuredData endpoint gets an array of mount points for Instant File Share Recovery.

Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of mount points to skip.

limit
integer <int32>

Maximum number of mount points to return.

orderColumn
string (EInstantUnstructuredDataRecoveryMountsFiltersOrderColumn)

Sorts mount points by one of the mount point parameters.

Enum: "State" "Name"
orderAsc
boolean

If true, sorts mount points in ascending order by the orderColumn parameter.

stateFilter
string (EInstantRecoveryMountState)

Filters mount points by mount point state.

Enum: "Failed" "Mounting" "Mounted" "Dismounting"
shareNameFilter
string

Filters mount points by file share name.

header Parameters
x-api-version
required
string
Default: 1.3-rev2

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/unstructuredData
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Start Instant File Share Recovery
The HTTP POST request to the /api/v1/restore/instantRecovery/unstructuredData endpoint starts Instant File Share Recovery. 
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
required
Array of objects (UnstructuredDataRestoreOptionsModel) 
Array of options for Instant File Share Recovery.


 
autoSelectMountServers
boolean
If true, Veeam Backup & Replication will assign the backup server as a mount server.


 
reason
string
Reason for performing Instant Recovery.


 
Responses 
201
An InstantRecovery session 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/unstructuredData
Request samples 
application/json
{
  • "autoSelectMountServers": true,
  • "restoreOptions": [
    ],
  • "reason": "Verifying backup integrity"
}
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Mount Point for Instant File Share Recovery
The HTTP GET request to the /api/v1/restore/instantRecovery/unstructuredData/{mountId} endpoint gets an Instant Recovery mount point that has the specified mountID.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant File Share Recovery request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/unstructuredData/{mountId}
Request samples 
Response samples 
application/json
{
  • "state": "Published",
  • "id": "11a90854-7054-4441-881e-ac790904b62b",
  • "sessionId": "11a90854-7054-4441-881e-ac790904b62b",
  • "spec": {
    },
  • "unstructuredServerId": "6745a759-2205-4cd2-b172-8ec8f7e60ef8",
  • "unstructuredServerName": "\\\\srv85\\C:\\Shares\\nfs_share",
  • "errorMessage": ""
}
Stop File Share Publishing
The HTTP POST request to the /api/v1/restore/instantRecovery/unstructuredData/{mountId}/unmount endpoint stops publishing the file share and removes it from the destination server.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant File Share Recovery request.


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


 
Responses 
200
An InstantRecovery session has been started to stop publishing the file share. 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/unstructuredData/{mountId}/unmount
Request samples 
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Start File Share Migration
The HTTP POST request to the /api/v1/restore/instantRecovery/unstructuredData/{mountId}/migrate endpoint migrates the published file share to production. 
NOTE 
 This operation is supported for backups of SMB file shares only.
 
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant File Share Recovery request.


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


 
Request Body schema: application/json
required
required
object (UnstructuredDataShareMigrationDestinationModel) 
Destination for file share migration.


 
required
object (UnstructuredDataSwitchoverSettingsModel) 
Switchover settings for Instant File Share Recovery.


 
overwriteMode
string (EUnstructuredDataInstantRestoreOverwriteMode) 
Overwrite mode.


 Enum: "ReplaceOlder" "Overwrite"  
Responses 
201
An UnstructuredDataMigration session has been started to migrate the published file share to production. 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/unstructuredData/{mountId}/migrate
Request samples 
application/json
{
  • "destination": {
    },
  • "overwriteMode": "ReplaceOlder",
  • "switchoverSettings": {
    }
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Start File Share Switchover
The HTTP POST request to the /api/v1/restore/instantRecovery/unstructuredData/{mountId}/switchover endpoint starts switchover from the specified mount point. 
NOTE 
 This operation is supported for backups of SMB file shares only.
 
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant File Share Recovery request.


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


 
Responses 
201
An InstantRecovery session has been started to switch the unstructured data. To check the progress, track the session state.


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/unstructuredData/{mountId}/switchover
Request samples 
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Get File Share Switchover Settings
The HTTP GET request to the /api/v1/restore/instantRecovery/unstructuredData/{mountId}/switchoverSettings endpoint gets switchover settings for a mount point that has the specified mountID.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant File Share Recovery request.


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


 
Responses 
200
OK


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.


get/api/v1/restore/instantRecovery/unstructuredData/{mountId}/switchoverSettings
Request samples 
Response samples 
application/json
{
  • "type": "Scheduled",
  • "scheduleTime": "2025-10-21T08:14:47.754Z"
}
Update File Share Switchover Settings
The HTTP PUT request to the /api/v1/restore/instantRecovery/unstructuredData/{mountId}/switchoverSettings endpoint modifies switchover settings for an Instant Recovery mount point that has the specified mountID.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant File Share Recovery request.


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


 
Request Body schema: application/json
type
required
string (EUnstructuredDataInstantRecoverySwitchoverType) 
Switchover type.


 Enum: "Auto" "Manual" "Scheduled"  
scheduleTime
string <date-time> 
Date and time when switchover will be triggered.


 
Responses 
200
OK


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.


put/api/v1/restore/instantRecovery/unstructuredData/{mountId}/switchoverSettings
Request samples 
application/json
{
  • "type": "Scheduled",
  • "scheduleTime": "2025-10-21T08:14:47.754Z"
}
Response samples 
application/json
{
  • "type": "Scheduled",
  • "scheduleTime": "2025-10-21T08:14:47.754Z"
}
Start File Restore from Unstructured Data Backup
The HTTP POST request to the /api/v1/restore/flr/unstructuredData endpoint starts file restore from an unstructured data backup. The operation starts a file restore session and mounts the share to a mount point.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
unstructuredDataServerId
string <uuid> 
Unstructured data server ID. To get the ID, run the Get All Unstructured Data Servers request.
 If you use this property, do not specify the restorePointId property.


 
restorePointId
string <uuid> 
Restore point ID. To get the ID, run the Get All Restore Points request.
 If you use this property, do not specify the backupId and unstructuredDataServerId properties.


 
backupId
string <uuid> 
Backup ID. To get the ID, run the Get All Backups request.
 If you use this property, do not specify the restorePointId property.


 
object (FlrAutoUnmountModel) 
Settings for automatic unmount of the file system.


 
object (UnstructuredDataColdStorageRetrievalSettings) 
Settings for retrieving data from cold storage.


 
Responses 
201
Unstructured data share has been mounted.


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.


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/flr/unstructuredData
Request samples 
application/json
{
  • "unstructuredDataServerId": "3cd03b37-7685-40d5-a63b-7fec631e2ac9",
  • "backupId": "f0001e05-e072-418d-91b0-528f314b8b8e",
  • "autoUnmount": {
    }
}
Response samples 
application/json
{
  • "sessionId": "b7e1c2d3-4a5f-6789-abcd-ef0123456789",
  • "properties": {
    },
  • "sourceProperties": {
    }
}
Unmount Unstructured Data FLR Volumes
The HTTP POST request to the /api/v1/restore/unstructuredData/{sessionId}/unmount endpoint unmounts unstructured data backup files from a mount point and stops a file restore session that has the specified sessionId.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
sessionId
required
string <uuid> 
Restore session ID. To get the ID, run the Get All Sessions request.


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


 
Responses 
201
Restore session has been stopped.


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/unstructuredData/{sessionId}/unmount
Request samples 
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Prolong a Retrieval Operation from Cold Object Storage
The HTTP POST request to the /api/v1/restore/unstructuredData/retrieveFromArchiveStorage endpoint retrieves unstructured data from cold object storage. 
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
retrievalOperationId
required
string <uuid> 
Retrieval operation id.


 
availabilityPeriodDays
required
integer <int32> 
Number of days, the retrieved files must be kept available.


 
Responses 
201
A retrieval 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/unstructuredData/retrieveFromArchiveStorage
Request samples 
application/json
{
  • "retrievalOperationId": "d1e2f3a4-b5c6-7890-1234-56789abcdef0",
  • "availabilityPeriodDays": 7
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Get Cold Object Storage Retrieval Operations
The HTTP GET request to the /api/v1/restore/unstructuredData/retrieveFromArchiveStorage endpoint returns the current retrieval operations from cold object storage with their expiration periods. 
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
query Parameters
serverIdFilter
required
Array of strings <uuid> 
Filter retrievals to only show retrievals for points belonging to this backup source.


 
backupIdFilter
required
Array of strings <uuid> 
Filter retrievals to only show retrievals for points belonging to this backup.


 
restorePointIdFilter
required
Array of strings <uuid> 
Filter retrievals to only show retrievals for these points.


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


 
Responses 
201
The active retrievals


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.


get/api/v1/restore/unstructuredData/retrieveFromArchiveStorage
Request samples 
Response samples 
application/json
{
  • "data": [
    ]
}
Get All Mount Points for Instant Recovery to VMware vSphere
The HTTP GET request to the /api/v1/restore/instantRecovery/vSphere/vm endpoint gets an array of Instant Recovery mount points to VMware vSphere.
Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer, Security Administrator. Also available to custom roles that have backup or restore permissions.


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


 
limit
integer <int32> 
 Default:  200
Maximum number of mount points to return.


 
orderColumn
string (EInstantViVMRecoveryMountsFiltersOrderColumn) 
Sorts mount points by one of the mount point parameters.


 Enum: "State" "VmName" "JobName" "RestorePointDate" "HostName"  
orderAsc
boolean
If true, sorts mount points in ascending order by the orderColumn parameter.


 
stateFilter
string (EInstantRecoveryMountState) 
Filters mount points by mount point state.


 Enum: "Failed" "Mounting" "Mounted" "Dismounting"  
vmNameFilter
string
Filters mount points by the nameFilter pattern. The pattern can match any mount parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.


 
mountIdFilter
Array of strings <uuid> 
Filters mount points by the mountId property.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/vSphere/vm
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Start Instant Recovery to VMware vSphere
The HTTP POST request to the /api/v1/restore/instantRecovery/vSphere/vm endpoint starts Instant Recovery 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.
You can also instantly recover backups of other platforms (for example, Veeam Agent backups or backups of other hypervisors) to VMware vSphere. To do this, use the OtherPlatform type and specify the target VMware vSphere location in the destination property.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


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


 
type
required
string (EInstantVMRecoveryModeType) 
Instant Recovery restore mode.






Enum Value
Description





OriginalLocation
Veeam Backup & Replication will perform Instant Recovery to the original location.




Customized
Veeam Backup & Replication will perform Instant Recovery to a new location or to the original location with new settings.

Note: If you do not specify an optional property that defines target settings (such as VM name, destination host, resource pool, folder and so on), Veeam Backup & Replication will try to use the source settings for that property.		





 
required
object (SecureRestoreSpec) 
Secure restore settings.


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


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


 
reason
string
Reason for restoring the VM.


 
overwrite
boolean
If true, the existing VM with the same name is overwritten.


 
shareCredentialsId
string <uuid> 
Credentials to network share the restorePoint is located on. If needed.


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


 
Responses 
201
An InstantRecovery session has been started to start Instant Recovery. 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/vSphere/vm
Request samples 
application/json
{
  • "restorePointId": "af75ddaa-d680-4c50-ac82-07834a007707",
  • "type": "OriginalLocation",
  • "vmTagsRestoreEnabled": true,
  • "secureRestore": {
    },
  • "nicsEnabled": false,
  • "powerUp": true,
  • "reason": "Instant Recovery to VMware vSphere"
}
Response samples 
application/json
{
  • "sessionType": "InstantRecovery",
  • "state": "Working",
  • "id": "2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "name": "apache05",
  • "jobId": "9239c712-3c0e-49e9-ae4d-c9c6267504e0",
  • "creationTime": "2024-03-07T19:31:23.07555+01:00",
  • "endTime": "2024-03-07T19:35:45.12345+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "resourceId": "2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "resourceReference": "/api/v1/restore/instantRecovery/vmware/vm/2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "usn": 0
}
Get Mount Point for Instant Recovery to VMware vSphere
The HTTP GET request to the /api/v1/restore/instantRecovery/vSphere/vm/{mountId} endpoint gets an Instant Recovery mount point that has the specified mountID.
Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer, Security Administrator. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to VMware vSphere request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/vSphere/vm/{mountId}
Request samples 
Response samples 
application/json
{
  • "state": "Mounted",
  • "id": "32441b29-d55c-4b20-801a-c1b17cd75d55",
  • "sessionId": "32441b29-d55c-4b20-801a-c1b17cd75d55",
  • "spec": {
    },
  • "vmName": "apache04",
  • "errorMessage": "",
  • "jobName": "VMware Backup Job",
  • "restorePointDate": "2024-11-15T14:30:00Z"
}
Stop Publishing Machine to VMware vSphere
The HTTP POST request to the /api/v1/restore/instantRecovery/vSphere/vm/{mountId}/unmount endpoint stops publishing the recovered machine and removes it from the destination host.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to VMware vSphere request.


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


 
Responses 
200
An InstantRecovery session has been started to stop publishing the VM. 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/vSphere/vm/{mountId}/unmount
Request samples 
Response samples 
application/json
{
  • "sessionType": "InstantRecovery",
  • "state": "Working",
  • "id": "2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "name": "apache05",
  • "jobId": "9239c712-3c0e-49e9-ae4d-c9c6267504e0",
  • "creationTime": "2024-03-07T19:31:23.07555+01:00",
  • "endTime": "2024-03-07T19:35:45.12345+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "resourceId": "2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "resourceReference": "/api/v1/restore/instantRecovery/vmware/vm/2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "usn": 0
}
Start Migrating Machine to VMware vSphere
The HTTP POST request to the /api/v1/restore/instantRecovery/vSphere/vm/{mountId}/migrate endpoint starts migrating the machine for which you have started Instant Recovery, using the specified mount point. 
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to VMware vSphere request.


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


 
Request Body schema: application/json
required
object (InventoryObjectModel) 
Inventory object properties.


 
object (InventoryObjectModel) 
Inventory object properties.


 
object (InventoryObjectModel) 
Inventory object properties.


 
object (ViVMQuickMigrationDatastoresSpec) 
Destination datastore.


 
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
A QuickMigration session has been started to migrate the VM. 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/vSphere/vm/{mountId}/migrate
Request samples 
application/json
{
  • "destinationHost": {
    },
  • "folder": {
    },
  • "resourcePool": {
    },
  • "datastore": {
    },
  • "sourceProxyIds": [
    ],
  • "targetProxyIds": [
    ],
  • "VeeamQMEnabled": true,
  • "DeleteSourceVmsFiles": false
}
Response samples 
application/json
{
  • "sessionType": "QuickMigration",
  • "state": "Stopped",
  • "id": "8228661b-861e-40c4-8133-8a97700f4dfa",
  • "name": "Quick Migration Job",
  • "jobId": "a00aa837-2c85-40c9-ae98-8b089dabc9b5",
  • "creationTime": "2024-03-07T21:16:08.216977+01:00",
  • "endTime": "2024-03-07T21:22:45.678901+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "resourceId": "8228661b-861e-40c4-8133-8a97700f4dfa",
  • "usn": 0
}
Get All Mount Points for Instant Recovery to Microsoft Hyper-V
The HTTP GET request to the /api/v1/restore/instantRecovery/hyperV/vm endpoint gets an array of Instant Recovery mount points to Microsoft Hyper-V.
Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer, Security Administrator. Also available to custom roles that have backup or restore permissions.


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


 
limit
integer <int32> 
 Default:  200
Maximum number of mount points to return.


 
orderColumn
string (EInstantHvVMRecoveryMountsFiltersOrderColumn) 
Sorts mount points by one of the mount point parameters.


 Enum: "State" "VmName" "JobName" "RestorePointDate" "HostName"  
orderAsc
boolean
If true, sorts mount points in ascending order by the orderColumn parameter.


 
stateFilter
string (EInstantRecoveryMountState) 
Filters mount points by mount point state.


 Enum: "Failed" "Mounting" "Mounted" "Dismounting"  
vmNameFilter
string
Filters mount points by backup job name.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/hyperV/vm
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Start Instant Recovery to Microsoft Hyper-V
The HTTP POST request to the /api/v1/restore/instantRecovery/hyperV/vm endpoint starts Instant Recovery to Microsoft Hyper-V. 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.
You can also instantly recover backups of other platforms (for example, Veeam Agent backups or backups of other hypervisors) to Microsoft Hyper-V. To do this, use the OtherPlatform type and specify the target Microsoft Hyper-V location in the destinationHost property.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


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


 
type
required
string (EInstantVMRecoveryModeType) 
Instant Recovery restore mode.






Enum Value
Description





OriginalLocation
Veeam Backup & Replication will perform Instant Recovery to the original location.




Customized
Veeam Backup & Replication will perform Instant Recovery to a new location or to the original location with new settings.

Note: If you do not specify an optional property that defines target settings (such as VM name, destination host, resource pool, folder and so on), Veeam Backup & Replication will try to use the source settings for that property.		





 
object (SecureRestoreSpec) 
Secure restore settings.


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


 
reason
string
Reason for restoring the VM.


 
shareCredentialsId
string <uuid> 
Credentials to network share the restorePoint is located on. If needed.


 
Responses 
201
An InstantRecovery session has been started to start Instant Recovery. 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/hyperV/vm
Request samples 
application/json
{
  • "type": "OriginalLocation",
  • "restorePointId": "070f0e5b-7f69-443b-a34e-59b30b22da6a",
  • "secureRestore": {
    },
  • "powerUp": true,
  • "reason": "Recovery to previous state"
}
Response samples 
application/json
{
  • "sessionType": "InstantRecovery",
  • "state": "Working",
  • "id": "2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "name": "apache05",
  • "jobId": "9239c712-3c0e-49e9-ae4d-c9c6267504e0",
  • "creationTime": "2024-03-07T19:31:23.07555+01:00",
  • "endTime": "2024-03-07T19:35:45.12345+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "resourceId": "2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "resourceReference": "/api/v1/restore/instantRecovery/vmware/vm/2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "usn": 0
}
Get Mount Point for Instant Recovery to Microsoft Hyper-V
The HTTP GET request to the /api/v1/restore/instantRecovery/hyperV/vm/{mountId} endpoint gets an Instant Recovery mount point that has the specified mountID.
Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer, Security Administrator. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to Microsoft Hyper-V request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/hyperV/vm/{mountId}
Request samples 
Response samples 
application/json
{
  • "state": "Mounted",
  • "id": "76683fbf-9cc0-4766-a169-f01918fdaa60",
  • "sessionId": "76683fbf-9cc0-4766-a169-f01918fdaa60",
  • "spec": {
    },
  • "vmName": "appsrv001-ir729",
  • "jobName": "Backup Job 1 - appsrv001",
  • "restorePointDate": "2025-07-29T13:25:32.973718",
  • "hostName": "pdctwhv02.tech.local"
}
Stop Publishing Machine to Microsoft Hyper-V
The HTTP POST request to the /api/v1/restore/instantRecovery/hyperV/vm/{mountId}/unmount endpoint stops publishing the recovered machine and removes it from the destination host.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to Microsoft Hyper-V request.


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


 
Responses 
200
An InstantRecovery session has been started to stop publishing the VM. 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/hyperV/vm/{mountId}/unmount
Request samples 
Response samples 
application/json
{
  • "sessionType": "InstantRecovery",
  • "state": "Working",
  • "id": "2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "name": "apache05",
  • "jobId": "9239c712-3c0e-49e9-ae4d-c9c6267504e0",
  • "creationTime": "2024-03-07T19:31:23.07555+01:00",
  • "endTime": "2024-03-07T19:35:45.12345+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "resourceId": "2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "resourceReference": "/api/v1/restore/instantRecovery/vmware/vm/2e0bf225-91b3-4005-8524-6f7971e9ac4f",
  • "usn": 0
}
Start Migrating Machine to Microsoft Hyper-V
The HTTP POST request to the /api/v1/restore/instantRecovery/hyperV/vm/{mountId}/migrate endpoint starts migrating the machine for which you have started Instant Recovery, using the specified mount point. 
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to Microsoft Hyper-V request.


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


 
Responses 
204
VM has been migrated to production.


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/hyperV/vm/{mountId}/migrate
Request samples 
Response samples 
application/json
{
  • "errorCode": "UnexpectedContent",
  • "message": "One or more request parameters are not valid."
}
Get All Mount Points for Instant Recovery to Microsoft Azure
The HTTP GET request to the /api/v1/restore/instantRecovery/azure/vm endpoint gets an array of Instant Recovery mount points of Microsoft Azure VMs. 
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


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


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


 Enum: "State" "Name"  
orderAsc
boolean
Sorts mounts in ascending order by the orderColumn parameter.


 
stateFilter
string (EAzureInstantRecoveryMountState) 
Filters mounts by mount state.


 Enum: "Ready" "Migrating" "ReadyToSwitch" "Switching" "Starting" "Stopping" "Stopped"  
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/azure/vm
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Start Instant Recovery to Microsoft Azure
The HTTP POST request to the /api/v1/restore/instantRecovery/azure/vm endpoint starts Instant Recovery of a Linux or Microsoft Windows machine to Microsoft Azure. 
NOTE
 Deploying a helper appliance template with REST API is not supported in this version. Before you run this request, you must deploy a helper appliance template in the Veeam Backup & Replication UI or with the Deploy-VBRAzureApplianceTemplate cmdlet.
 
 To get the values required in the request body, run the following requests:
     
  1.  Run the Get All Restore Points request to get the RestorePointId property value.
    2.  
  2.  Run the Get Restore Point Disks request to get the diskUid property value.
    3.  
  3.  Run the Get All Cloud Credentials request to get the subscriptionId property value. Use the ID that Veeam Backup & Replication assigned to the Microsoft Azure subscription. You can find this ID in the data[x].subscription.subscriptions[y].id property, where x and y are the ordinal numbers of the objects in the arrays.
    4.  
  4.  Run the Get Cloud Hierarchy request to get the values for the remaining required properties.
 
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
restorePointId
required
string <uuid> 
Restore point ID. To get the ID, run the Get All Restore Points request.


 
required
object (AzureComputeSubscriptionModel) 
Microsoft Azure compute subscription.


 
required
object (AzureComputeVMSizeModel) 
Size settings for Microsoft Azure VM.


 
required
object (AzureComputeResourceGroupModel) 
Microsoft Azure resource group.


 
required
object (AzureComputeNetworkModel) 
Microsoft Azure VM network settings.


 
required
object (AzureInstantVMRecoveryApplianceModel) 
Helper appliance for Instant Recovery to Microsoft Azure.


 
object (AzureComputeNameModel) 
Name of Microsoft Azure VM.


 
reason
string
Reason for performing Instant Recovery to Microsoft Azure.


 
verifyVMBoot
boolean
If true, Veeam Backup & Replication will verify whether the restored VM has booted properly.


 
Responses 
201
Microsoft Azure Instant Recovery mount has been initiated to start Instant Recovery. To check the progress, track the mount 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/azure/vm
Request samples 
application/json
{
  • "restorePointId": "be6e2a88-1d7d-46cc-b375-616c632ab8df",
  • "subscription": {
    },
  • "name": {
    },
  • "vmSize": {
    },
  • "resourceGroup": {
    },
  • "network": {
    },
  • "appliance": {
    },
  • "reason": "Started at 7/12/2025 1:36:21 PM",
  • "verifyVMBoot": false
}
Response samples 
application/json
{
  • "state": "Starting",
  • "id": "4e920162-6c42-4483-9b7a-768ed40d31fe",
  • "spec": {
    },
  • "errorMessage": ""
}
Get Mount Point for Instant Recovery to Microsoft Azure
The HTTP GET request to the /api/v1/restore/instantRecovery/azure/vm/{mountId} endpoint gets an Instant Recovery mount point that has the specified mountID.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to Microsoft Azure request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/azure/vm/{mountId}
Request samples 
Response samples 
application/json
{
  • "state": "Starting",
  • "id": "4e920162-6c42-4483-9b7a-768ed40d31fe",
  • "spec": {
    },
  • "errorMessage": ""
}
Get All Mount Sessions for Instant Recovery to Microsoft Azure
The HTTP GET request to the /api/v1/restore/instantRecovery/azure/vm/{mountId}/sessions endpoint gets an array of Instant Recovery sessions associated with a mount point.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to Microsoft Azure request.


 
query Parameters
skip
integer <int32> 
Number of mount sessions to skip.


 
limit
integer <int32> 
 Default:  200
Maximum number of mount sessions to return.


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


 Enum: "Name" "SessionType" "CreationTime" "EndTime" "State" "Result" "InitiatedBy"  
orderAsc
boolean
Sorts mount sessions in ascending order by the orderColumn parameter.


 
createdAfterFilter
string <date-time> 
Returns sessions that are created after the specified date and time.


 
createdBeforeFilter
string <date-time> 
Returns sessions that are created before the specified date and time.


 
endedAfterFilter
string <date-time> 
Returns sessions that are finished after the specified date and time.


 
endedBeforeFilter
string <date-time> 
Returns sessions that are finished before the specified date and time.


 
typeFilter
string (ESessionType) 
Filters sessions by session type.


 Enum: "Infrastructure" "BackupJob" "Automation" "ConfigurationBackup" "PublishBackupContentViaMount" "RepositoryMaintenance" "RepositoryEvacuate" "InfrastructureItemDeletion" "RestoreVm" "InstantRecovery" "FirstClassDiskInstantRestore" "AzureApplianceDeploy" "QuickMigration" "FileLevelRestore" "LinuxFileLevelRestore" "ReplicaJob" "ConfigurationResynchronize" "Failover" "PlannedFailover" "PermanentFailover" "UndoFailover" "Failback" "CommitFailback" "UndoFailback" "SwitchReplicaToProduction" "CloudDirectorVmRestore" "CloudDirectorVAppRestore" "MalwareDetection" "FirstClassDiskQuickMigration" "EntraIdRestore" "EntraIdRestoreFromCopy" "UnstructuredDataBackupCopy" "SecurityComplianceAnalyzer" "FileServerSave" "SureBackup" "NasRestore" "LogsExport" "TestCredentials" "SqlLogBackup" "OracleLogBackup" "PostgreSqlLogBackup" "AzureInstantRecovery" "AzureInstantRecoveryMigration" "AzureInstantRecoverySwitchover" "AzureInstantRecoveryStart" "AzureInstantRecoveryStop" "AzureInstantRecoveryMigrationUndo" "AzureInstantRecoveryMount" "FileInstantRecovery" "FileInstantRecoveryMigration" "PublishBackupContentViaNfs" "VolumesDiscover" "DeleteBackup" "BackgroundOperation" "AgentDiscovery" "AgentPolicy" "AgentBackup" "AgentOperationPurgeCache" "ApplianceUpdatesInstall" "FailoverPlan" "FailoverPlanTask" "UnstructuredDataBrowse" "BackupCopyJob" "UnstructuredDownloadMeta" "EntraIdRescanRepository" "HostComponentsUpdate" "CopyBackup" "FileBackupHealthCheck" "SureBackupContentScan" "ArchiveBackup" "ArchiveRehydration" "ArchiveSync" "ArchiveCopy" "ArchiveFreezing" "RetrieveBackup" "ArchiveTierDownload" "DirectBackupSync" "CheckpointRemoval" "IrisBackup" "Retention" "PlatformServiceJob" "PlatformBackupJob" "PlatformSnapshotJob" "PlatformSnapshotCopyJob" "AgentOperationBackupNow" "AgentOperationActiveFull" "AgentManagement" "BackupCopyJobParent" "ApplicationLevelRestore" "EncryptionAnalysis" "VeeamUpdaterSettingsSync" "EndpointBackup" "StorageDiscovery" "StorageMonitoring" "AdForestRestore" "AgentsRecoveryAppliancesManagement" "RestoreRecoveryApplianceVolumes" "RestoreAgentVolumes" "EndpointRestore" "EpAgentOperationStopBackup" "BackupCacheSync" "PerVmMoveBackup" "PerVmCopyBackup" "FileBackupArchiveRetrievalProlonging" "HaSwitchover" "IndexCollection" "InstantDiskRecovery" "DiskRestore" "HaClusterEdit"  
stateFilter
string (ESessionState) 
Filters sessions by session state.


 Enum: "Stopped" "Starting" "Stopping" "Working" "Pausing" "Resuming" "WaitingTape" "Idle" "Postprocessing" "WaitingRepository" "WaitingSlot" "ActionRequired"  
resultFilter
Array of strings (ESessionResult) 
Filters sessions by session result.


Items Enum: "None" "Success" "Warning" "Failed"  
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/azure/vm/{mountId}/sessions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Stop Publishing Machine to Microsoft Azure
The HTTP POST request to the /api/v1/restore/instantRecovery/azure/vm/{mountId}/unmount endpoint stops publishing the recovered VM and removes it from the destination host.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to Microsoft Azure request.


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


 
Responses 
201
An AzureInstantRecoveryStop session has been started to stop publishing the VM. To check the progress, track the mount 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/azure/vm/{mountId}/unmount
Request samples 
Response samples 
application/json
{
  • "state": "Starting",
  • "id": "4e920162-6c42-4483-9b7a-768ed40d31fe",
  • "spec": {
    },
  • "errorMessage": ""
}
Start Migrating Machine to Microsoft Azure
The HTTP POST request to the /api/v1/restore/instantRecovery/azure/vm/{mountId}/migrate endpoint starts VM migration from the specified Instant Recovery mount point.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to Microsoft Azure request.


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


 
Request Body schema: application/json
required
object (AzureInstantVMRecoverySwitchoverSettingsModel) 
Switchover settings for Instant Recovery to Microsoft Azure.


 
Responses 
201
An AzureInstantRecoveryMigration session has been started to migrate the VM. To check the progress, track the mount 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/azure/vm/{mountId}/migrate
Request samples 
application/json
{
  • "switchoverSettings": {
    }
}
Response samples 
application/json
{
  • "state": "Starting",
  • "id": "4e920162-6c42-4483-9b7a-768ed40d31fe",
  • "spec": {
    },
  • "errorMessage": ""
}
Get Settings for Switchover to Microsoft Azure
The HTTP GET request to the /api/v1/restore/instantRecovery/azure/vm/{mountId}/switchoverSettings endpoint gets switchover settings for an Instant Recovery mount point that has the specified mountID.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to Microsoft Azure request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/azure/vm/{mountId}/switchoverSettings
Request samples 
Response samples 
application/json
{
  • "type": "Scheduled",
  • "scheduleTime": "2025-08-24T14:15:22Z",
  • "verifyVMBoot": false,
  • "powerOnVM": true
}
Update Settings for Switchover to Microsoft Azure
The HTTP PUT request to the /api/v1/restore/instantRecovery/azure/vm/{mountId}/switchoverSettings endpoint modifies switchover settings for an Instant Recovery mount point that has the specified mountID.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to Microsoft Azure request.


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


 
Request Body schema: application/json
type
required
string (EAzureInstantVMRecoverySwitchoverType) 
Switchover type.


 Enum: "Auto" "Manual" "Scheduled"  
scheduleTime
string <date-time> 
Date and time when switchover will be triggered.


 
verifyVMBoot
boolean
If true, Veeam Backup & Replication will verify whether the restored VM has booted properly.


 
powerOnVM
boolean
If true, Veeam Backup & Replication will power on the VM.


 
Responses 
201
The switchover settings have been updated.


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.


put/api/v1/restore/instantRecovery/azure/vm/{mountId}/switchoverSettings
Request samples 
application/json
{
  • "type": "Scheduled",
  • "scheduleTime": "2025-08-24T14:15:22Z",
  • "verifyVMBoot": false,
  • "powerOnVM": true
}
Response samples 
application/json
{
  • "type": "Scheduled",
  • "scheduleTime": "2025-08-24T14:15:22Z",
  • "verifyVMBoot": false,
  • "powerOnVM": true
}
Start Switchover to Microsoft Azure
The HTTP POST request to the /api/v1/restore/instantRecovery/azure/vm/{mountId}/switchover endpoint starts switchover for a mount point that has the specified mountID.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All Mount Points for Instant Recovery to Microsoft Azure request.


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


 
Responses 
201
An AzureInstantRecoverySwitchover session has been started to initiate a VM switchover. To check the progress, track the mount state.


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/azure/vm/{mountId}/switchover
Request samples 
Response samples 
application/json
{
  • "state": "Starting",
  • "id": "4e920162-6c42-4483-9b7a-768ed40d31fe",
  • "spec": {
    },
  • "errorMessage": ""
}
Restore Entire VMware vSphere VM
The HTTP POST request to the /api/v1/restore/vmRestore/vSphere endpoint performs 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.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


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


 
type
required
string (EEntireVMRestoreModeType) 
Entire VM restore mode.






Enum Value
Description





OriginalLocation
Veeam Backup & Replication will restore the entire VM to the original location.




Customized
Veeam Backup & Replication will restore the entire VM to a new location or to the original location with new settings.

Note: If you do not specify an optional property that defines target settings (such as VM name, destination host, resource pool, datastore, folder or network), Veeam Backup & Replication will try to use the source settings for that property.		





 
object (RestoreProxySpec) 
Backup proxies for VM data transport.


 
object (SecureRestoreSpec) 
Secure restore settings.


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


 
reason
string
Reason for restoring the VM.


 
overwrite
boolean
If true, the existing VM with the same name is overwritten.


 
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/vSphere
Request samples 
application/json
{
  • "restorePointId": "0899c74d-53f0-413a-a731-e1e7297285ba",
  • "type": "OriginalLocation",
  • "restoreProxies": {
    },
  • "secureRestore": {
    },
  • "powerUp": true,
  • "reason": "Corruption of the VM",
  • "overwrite": true,
  • "quickRollback": true
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Restore Entire VMware Cloud Director VM
The HTTP POST request to the /api/v1/restore/vmRestore/cloudDirector endpoint performs entire VM restore of a VMware Cloud Director VM to VMware Cloud Director. 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.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


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


 
type
required
string (EEntireVMRestoreModeType) 
Entire VM restore mode.






Enum Value
Description





OriginalLocation
Veeam Backup & Replication will restore the entire VM to the original location.




Customized
Veeam Backup & Replication will restore the entire VM to a new location or to the original location with new settings.

Note: If you do not specify an optional property that defines target settings (such as VM name, destination host, resource pool, datastore, folder or network), Veeam Backup & Replication will try to use the source settings for that property.		





 
object (RestoreProxySpec) 
Backup proxies for VM data transport.


 
object (SecureRestoreSpec) 
Secure restore settings.


 
powerUp
boolean
If true, Veeam Backup & Replication powers on 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
A RestoreVm 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/cloudDirector
Request samples 
application/json
{
  • "restorePointId": "5a78f3e1-9c2b-4d6e-8f10-2a3b4c5d6e7f",
  • "type": "OriginalLocation",
  • "restoreProxies": {
    },
  • "secureRestore": {
    },
  • "powerUp": true,
  • "reason": "Corruption of the VM",
  • "quickRollback": true
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Restore Entire Microsoft Hyper-V VM
The HTTP POST request to the /api/v1/restore/vmRestore/hyperV endpoint performs entire VM restore of a Microsoft Hyper-V VM to Microsoft Hyper-V. 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.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


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


 
type
required
string (EEntireVMRestoreModeType) 
Entire VM restore mode.






Enum Value
Description





OriginalLocation
Veeam Backup & Replication will restore the entire VM to the original location.




Customized
Veeam Backup & Replication will restore the entire VM to a new location or to the original location with new settings.

Note: If you do not specify an optional property that defines target settings (such as VM name, destination host, resource pool, datastore, folder or network), Veeam Backup & Replication will try to use the source settings for that property.		





 
object (SecureRestoreSpec) 
Secure restore settings.


 
powerUp
boolean
If true, Veeam Backup & Replication powers on 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/hyperV
Request samples 
application/json
{
  • "restorePointId": "0899c74d-53f0-413a-a731-e1e7297285ba",
  • "type": "OriginalLocation",
  • "secureRestore": {
    },
  • "powerUp": true,
  • "reason": "Corruption of the VM",
  • "quickRollback": true
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Get All FCD Mount Points
The HTTP GET request to the /api/v1/restore/instantRecovery/vSphere/fcd endpoint gets an array of FCD mount points.
Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer. Also available to custom roles that have backup or restore permissions.


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


 
limit
integer <int32> 
 Default:  200
Maximum number of mount points to return.


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


 Enum: "State" "Name"  
orderAsc
boolean
If true, sorts mount points in ascending order by the orderColumn parameter.


 
stateFilter
string (EInstantRecoveryMountState) 
Filters mount points by mount point state.


 Enum: "Failed" "Mounting" "Mounted" "Dismounting"  
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/vSphere/fcd
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Start Instant FCD Recovery
The HTTP POST request to the /api/v1/restore/instantRecovery/vSphere/fcd endpoint starts 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 Inventory Objects.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


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


 
required
object (InventoryObjectModel) 
Inventory object properties.


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


 
object (VmwareFcdWriteCacheSpec) 
Write cache for recovered disks.


 
reason
string
Reason for restoring the FCD.


 
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/vSphere/fcd
Request samples 
application/json
{
  • "restorePointId": "0899c74d-53f0-413a-a731-e1e7297285ba",
  • "destinationCluster": {
    },
  • "disksMapping": [
    ],
  • "writeCache": {
    },
  • "reason": "Instant recovery of a corrupted disk"
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Get FCD Mount Point
The HTTP GET request to the /api/v1/restore/instantRecovery/vSphere/fcd/{mountId} endpoint gets information about the mounted vPower NFS datastore, such as restore session ID, mount point state, instant FCD recovery settings and disks that will be recovered.
Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All FCD Mount Points request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
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/vSphere/fcd/{mountId}
Request samples 
Response samples 
application/json
{
  • "id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
  • "sessionId": "b7e1c2d3-4a5f-6789-abcd-ef0123456789",
  • "state": "Mounted",
  • "spec": {
    },
  • "mountedDisks": [
    ]
}
Stop FCD Publishing
The HTTP POST request to the /api/v1/restore/instantRecovery/vSphere/fcd/{mountId}/dismount endpoint stops publishing the recovered FCDs and removes the disks from the datastore.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All FCD Mount Points request.


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


 
Responses 
200
The disks have 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/vSphere/fcd/{mountId}/dismount
Request samples 
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Start FCD Migration
The HTTP POST request to the /api/v1/restore/instantRecovery/vSphere/fcd/{mountId}/migrate endpoint starts migration of FCDs from the specified mount point.
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 Inventory Objects.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID. To get the ID, run the Get All FCD Mount Points request.


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


 
Request Body schema: application/json
required
required
object (InventoryObjectModel) 
Inventory object properties.


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


 
object (InventoryObjectModel) 
Inventory object properties.


 
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/vSphere/fcd/{mountId}/migrate
Request samples 
application/json
{
  • "mountedDiskNames": [
    ],
  • "targetDatastore": {
    },
  • "storagePolicy": {
    }
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Start File Restore
The HTTP POST request to the /api/v1/restore/flr endpoint starts file restore from a backup or replica of a Microsoft Windows or Linux machine. The operation starts a file restore session and mounts the machine file system to a mount point.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
restorePointId
required
string <uuid> 
ID of the restore point from which you want to restore files.


 
type
required
string (EFlrType) 
Restore type.


 
required
object (FlrAutoUnmountModel) 
Settings for automatic unmount of the file system.


 
mountMode
required
string (EFlrMountModeType) 
Mount mode.


 Enum: "Automatic" "Manual"  
reason
string
Reason for restoring files.


 
credentialsId
string <uuid> 
ID of the credentials record used to connect to the source machine. The credentials will be used to compare files of the backup and the source machine.


 
object (WindowsFlrMountServerSettings) 
Mount server settings for file restore from Microsoft Windows machines. Specify these mount server settings if the mountMode property is set to Manual.


 
Responses 
201
File system has been mounted.


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.


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/flr
Request samples 
application/json
{
  • "restorePointId": "5777a78d-62f6-40a3-a7e3-8b56a56e58c0",
  • "type": "Linux",
  • "autoUnmount": {
    },
  • "reason": "File restore",
  • "mountMode": "Manual",
  • "mountServer": {
    }
}
Response samples 
application/json
{
  • "type": "Linux",
  • "sessionId": "1dc723e8-12a0-4480-bc34-6cb117d3d4a1",
  • "restorePointId": "ab3361d3-df80-474d-b23f-ea9a498b9e8c",
  • "mountErrors": [ ],
  • "properties": {
    },
  • "sourceProperties": {
    }
}
Unmount File System
The HTTP POST request to the /api/v1/restore/flr/{sessionId}/unmount endpoint unmounts the file system from a mount point and stops a file restore session that has the specified sessionId.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
sessionId
required
string <uuid> 
Restore session ID. To get the ID, run the Get All File Restore Mount Points request.


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


 
Responses 
201
Restore session has been stopped.


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/flr/{sessionId}/unmount
Request samples 
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Get User Code for Delegated Restore of Microsoft Entra ID Items
The HTTP POST request to the /api/v1/restore/entraId/tenant/deviceCode endpoint obtains a user code required to get credentials for delegated restore of Microsoft Entra ID items.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
sessionId
required
string <uuid> 
Mount session ID.


 
Responses 
201
User and device codes have been received.


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.


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/entraId/tenant/deviceCode
Request samples 
application/json
{
  • "sessionId": "b7e1c2d3-4a5f-6789-abcd-ef0123456789"
}
Response samples 
application/json
{
  • "userCode": "A1B2C3D4E",
  • "deviceCode": "GmRhmhcxhwAzkoEqiMEg_DnyEysRdbN6xY7L8Hk0e8j",
  • "verificationUrl": "https://microsoft.com/devicelogin",
  • "message": "To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code 000000000 to authenticate.",
  • "clientId": "9f8e7d6c-5b4a-3210-fedc-ba9876543210",
  • "expiresOn": "2026-06-19T10:45:00Z"
}
Get Credentials for Delegated Restore of Microsoft Entra ID Items
The HTTP POST request to the /api/v1/restore/entraId/tenant/deviceCode/state endpoint gets credentials that are required for delegated restore of Microsoft Entra ID items. Before you request the credentials, obtain a user code using the Get User Code for Delegated Restore of Microsoft Entra ID Items request.
You can use the credentials in the following requests:
 
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
sessionId
required
string <uuid> 
Mount session ID.


 
userCode
required
string
User code. To get the code, run the Get User Code for Delegated Restore of Microsoft Entra ID Items request.


 
Responses 
200
OK


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.


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/entraId/tenant/deviceCode/state
Request samples 
application/json
{
  • "sessionId": "b7e1c2d3-4a5f-6789-abcd-ef0123456789",
  • "userCode": "A1B2C3D4E"
}
Response samples 
application/json
{
  • "credentialsId": "3cd03b37-7685-40d5-a63b-7fec631e2ac9",
  • "status": "Success",
  • "username": "TECH\\Administrator"
}
Get Redirect URI for Delegated Restore of Microsoft Entra ID Items
The HTTP GET request to the /api/v1/restore/entraId/tenant/{sessionId}/authCode/startAuthorization endpoint obtains a redirect URI required to perform authorization code flow for delegated restore of Microsoft Entra ID items.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
"


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


 
query Parameters
vdcSessionId
required
string
Veeam Data Cloud session ID.


 
redirectUri
required
string <uri> 
Application redirect URI (where code will be redirected to).


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


 
Responses 
200
Redirect URI has been generated.


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.


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/entraId/tenant/{sessionId}/authCode/startAuthorization
Request samples 
Response samples 
application/json
{}
Perform Authorization Code Exchange for Delegated Restore of Microsoft Entra ID Items
The HTTP POST request to the /api/v1/restore/entraId/tenant/authCode/authorize endpoint performs code exchange part of authorization code flow for delegated restore of Microsoft Entra ID items.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.
"


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


 
Request Body schema: application/json
required
sessionId
required
string <uuid> 
Mount session ID.


 
code
string
Authorization code returned by the authorization provider.


 
state
string
State string returned by the authorization provider.


 
error
string
Error summary.


 
errorDescription
string
Error description.


 
Responses 
200
Authorization code exchange has been successful.


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.


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/entraId/tenant/authCode/authorize
Request samples 
application/json
{
  • "code": "0.AXcAk2pZ0qhT...authcode...",
  • "state": "f3a9b1c2-d4e5-6789-abcd-ef0123456789",
  • "sessionId": "b7e1c2d3-4a5f-6789-abcd-ef0123456789"
}
Response samples 
application/json
{
  • "successful": true,
  • "credentialsId": "3cd03b37-7685-40d5-a63b-7fec631e2ac9"
}
Mount Microsoft Entra ID Tenant
The HTTP POST request to the /api/v1/restore/entraId/tenant endpoint mounts a Microsoft Entra ID tenant from its backup and starts a mount session required for Microsoft Entra ID tenant restore.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
backupId
required
string <uuid> 
ID of a Microsoft Entra ID tenant backup.


 
Responses 
201
Tenant has been mounted.


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.


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/entraId/tenant
Request samples 
application/json
{
  • "backupId": "c4d5e6f7-a8b9-0123-4567-89abcdef0123"
}
Response samples 
application/json
{
  • "sessionId": "783241eb-5b56-4456-9736-379206ffc600",
  • "sourceProperties": {
    }
}
Start Microsoft Entra ID Tenant Restore from Copy
The HTTP POST request to the /api/v1/restore/entraId/tenant/fromCopy endpoint starts restore from backup copy for a Microsoft Entra ID tenant.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
restorePointId
required
string <uuid> 
ID of a Microsoft Entra ID tenant restore point.


 
object (UnstructuredDataColdStorageRetrievalSettings) 
Settings for retrieving data from cold storage.


 
Responses 
201
An EntraIdRestoreFromCopy session has been created to start restore from backup copy for a Microsoft Entra ID tenant. 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.


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/entraId/tenant/fromCopy
Request samples 
application/json
{
  • "restorePointId": "8c843d10-6d0f-4abe-b898-e1ba18b94f68",
  • "coldStorageRetrievalSettings": {
    }
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Unmount Microsoft Entra ID Tenant
The HTTP POST request to the /api/v1/restore/entraId/tenant/{sessionId}/stop endpoint unmounts a Microsoft Entra ID tenant and stops a mount session that has the specified sessionId.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


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


 
Request Body schema: application/json
optional
gracefulStop
required
boolean
 Default:  true
If true, Veeam Backup & Replication will produce a new restore point for those VMs that have already been processed and for VMs that are being processed at the moment.


 
cancelChainedJobs
boolean
 Default:  false
If true, Veeam Backup & Replication will cancel chained jobs.


 
Responses 
201
Mount session has been stopped.


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/entraId/tenant/{sessionId}/stop
Request samples 
application/json
{
  • "gracefulStop": true,
  • "cancelChainedJobs": false
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Start Microsoft Entra ID Audit Log Restore
The HTTP POST request to the /api/v1/restore/entraId/auditLog endpoint starts the Microsoft Entra ID audit log restore from a backup of Microsoft Entra ID audit logs. The operation starts a file restore session and mounts the log files to a mount point.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
unstructuredDataServerId
string <uuid> 
Unstructured data server ID. To get the ID, run the Get All Unstructured Data Servers request.
 If you use this property, do not specify the restorePointId property.


 
restorePointId
string <uuid> 
Restore point ID. To get the ID, run the Get All Restore Points request.
 If you use this property, do not specify the backupId and unstructuredDataServerId properties.


 
backupId
string <uuid> 
Backup ID. To get the ID, run the Get All Backups request.
 If you use this property, do not specify the restorePointId property.


 
object (FlrAutoUnmountModel) 
Settings for automatic unmount of the file system.


 
object (UnstructuredDataColdStorageRetrievalSettings) 
Settings for retrieving data from cold storage.


 
Responses 
201
Log files have been mounted.


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.


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/entraId/auditLog
Request samples 
application/json
{
  • "unstructuredDataServerId": "3cd03b37-7685-40d5-a63b-7fec631e2ac9",
  • "backupId": "f0001e05-e072-418d-91b0-528f314b8b8e",
  • "autoUnmount": {
    }
}
Response samples 
application/json
{
  • "sessionId": "b7e1c2d3-4a5f-6789-abcd-ef0123456789",
  • "properties": {
    },
  • "sourceProperties": {
    }
}
Unmount Microsoft Entra ID Audit Logs
The HTTP POST request to the /api/v1/restore/entraId/auditLog/{sessionId}/unmount endpoint unmounts Microsoft Entra ID log files from a mount point and stops a file restore session that has the specified sessionId.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


SecurityBearer 
Request 
path Parameters
sessionId
required
string <uuid> 
Restore session ID.


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


 
Responses 
201
Restore session has been stopped.


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/entraId/auditLog/{sessionId}/unmount
Request samples 
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Starts Volume Restore for Agent or Recovery Appliance
The HTTP POST request to the /api/v1/restore/startVolumeRestore endpoint starts Volume Restore for Agent or Recovery Appliance.
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have restore permissions.


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


 
Request Body schema: application/json
required
diskManagementSessionId
required
string <uuid> 
Disk management session ID.


 
required
object (DiskMappingContext) 
Disk mapping context.


 
reason
string
Reason for starting volume restore operation.


 
injectDrivers
boolean
If true, drivers are injected during the volume restore operation.


 
Responses 
201
A session has been created to restore volumes. To check the progress, track the session state.


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.


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/startVolumeRestore
Request samples 
application/json
{
  • "diskManagementSessionId": "e5f6a7b8-c9d0-1234-5678-9abcdef01234",
  • "diskMappingContext": {
    },
  • "reason": "Restore corrupted system volume",
  • "injectDrivers": true
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}