How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Veeam Restore API

The Restore section defines paths and operations for performing restore. NOTEIn the current version, the REST API supports the following recovery operations: Instant Recovery of a VMware vSphere VM to VMware vSphere Entire VM restore of a VMware vSphere VM to VMware vSphere Restore of disks that will be registered as First Class Disks (FCD) — a type of virtual disks that can be managed independent of any VM.

Veeam Restore API is one of 55 APIs that Veeam publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Restore. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 9 paths, and defines 44 schemas. It is described by OpenAPI 3.0.0, at version 1.0-rev0.

Requests are made against the base URL https://localhost:9419.

11 operations 9 paths 44 schemas 4 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0-rev0
Base URL
https://localhost:9419
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Veeam Restore API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — Bearer \

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 4 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Restore 11

The Restore section defines paths and operations for performing restore. NOTE In the current version, the REST API supports the following recovery operations: Instant Recovery of…

GET
/api/v1/restore/instantRecovery/vmware/fcd
Get All FCD Mounts
GetAllVmwareFcdInstantRecoveryMountModels 6 params → 200401403404500
POST
/api/v1/restore/instantRecovery/vmware/fcd
Start Instant FCD Recovery
InstantRecoveryVmwareFcdMountWithSession 1 param body → 201400401403404500
GET
/api/v1/restore/instantRecovery/vmware/fcd/{mountId}
Get FCD Mount
GetVmwareFcdInstantRecoveryMountModel 2 params → 200401403404500
POST
/api/v1/restore/instantRecovery/vmware/fcd/{mountId}/dismount
Stop FCD Publishing
InstantRecoveryVmwareFcdDismountWithSession 2 params → 200400401403404500
POST
/api/v1/restore/instantRecovery/vmware/fcd/{mountId}/migrate
Start FCD Migration
InstantRecoveryVmwareFcdMigrateWithSession 2 params body → 200400401403404500
GET
/api/v1/restore/instantRecovery/vmware/vm
Get All VM Mounts
GetAllInstantViVMRecoveryMounts 6 params → 200401403404500
POST
/api/v1/restore/instantRecovery/vmware/vm
Start Instant Recovery
InstantViVMRecoveryMount 1 param body → 201400401403404500
GET
/api/v1/restore/instantRecovery/vmware/vm/{mountId}
Get VM Mount
GetInstantViVMRecoveryMount 2 params → 200401403404500
POST
/api/v1/restore/instantRecovery/vmware/vm/{mountId}/migrate
Start VM Migration
InstantViVMRecoveryMigrate 2 params body → 200400401403404500
POST
/api/v1/restore/instantRecovery/vmware/vm/{mountId}/unmount
Stop VM Publishing
InstantViVMRecoveryUnmount 2 params → 200400401403404500
POST
/api/v1/restore/vmRestore/vmware/
Start Entire VM Restore
EntireVmRestoreVmware 1 param body → 201400401403404500

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are SessionModel (13 properties), ViVMQuickMigrationSpec (8 properties), BaseInstantViVMRecoverySpec (7 properties), BaseEntireViVMRestoreSpec (6 properties). Each schema is shown below with its type and property counts.

InstantViVMRecoveryMountsFilters
object
6 properties
ViVMQuickMigrationSpec
object
8 properties 1 required
EInstantViVmRecoveryBiosUuidPolicyType
string
BIOS UUID policy for the restored VM.
BaseEntireViVMRestoreSpec
object
6 properties
VmwareFcdWriteCacheSpec
object
Write cache for recovered disks.
3 properties 1 required
RestoreProxySpec
object
Backup proxies for VM data transport.
2 properties 1 required
InstantViVMCustomizedRecoveryDatastoreSpec
object
Datastore that keeps redo logs with changes that take place while a VM is running from a backup.
2 properties 1 required
VmwareFcdInstantRecoveryMountsResult
object
2 properties 2 required
VmwareObjectModel
object
VMware vSphere object.
4 properties 3 required
Error
object
3 properties 2 required
RestoreTargetDatastoreSpec
object
Destination datastore.
2 properties
VmwareFcdInstantRecoveryDiskSpec
object
3 properties 3 required
InstantViVMCustomizedRecoverySpec
Instant Recovery to a new location or with different settings.
InstantViVMRecoveryMountsResult
object
2 properties 2 required
VmwareFcdInstantRecoveryMount
object
6 properties 4 required
VmwareFcdQuickMigrationSpec
object
3 properties 1 required
SessionModel
object
13 properties 7 required
VmwareFcdInstantRecoveryDiskInfo
object
4 properties 4 required
PaginationResult
object
Pagination settings.
4 properties 2 required
EEntireVMRestoreModeType
string
Restore mode.
SecureRestoreSpec
object
Secure restore settings.
3 properties 1 required
RestoreTargetNetworkSpec
object
Network to which the restored VM is connected.
2 properties 1 required
InstantViVMRecoveryMount
object
VM mount.
6 properties 5 required
ESessionResult
string
Result status.
EDiskCreationMode
string
Disk format of the restored VM.
SessionResultModel
object
Session result.
3 properties 1 required
BaseInstantViVMRecoverySpec
object
7 properties
EVirusDetectionAction
string
Action that Veeam Backup & Replication takes if the antivirus software finds a threat.
EntireViVMCustomizedRestoreSpec
Restore to a new location or with different settings. To get models of the destination host and resource pool, use the [Get VMware vSphere Server Objects](tag/…
EVmwareInventoryType
string
Type of the VMware vSphere object.
InstantViVMRecoverySpec
EntireViVMOriginalLocationRestoreSpec
Restore to the original location with initial settings.
EInstantRecoveryMountState
string
Mount state.
ESessionState
string
State of the session.
InstantViVMCustomizedRecoveryDestinationSpec
object
Destination where the recovered VM resides. To get models of the destination host, folder and resource pool, use the [Get VMware vSphere Server Objects](tag/In…
5 properties 5 required
EVmwareFcdInstantRecoveryMountsFiltersOrderColumn
string
RestoreTargetFolderSpec
object
Destination VM folder.
3 properties 1 required
VmwareFcdInstantRecoverySpec
object
Instant FCD Recovery configuration: Restore point ID Destination cluster Disks for restore Write cache
4 properties 3 required
ESessionType
string
Type of the session.
EntireViVMRestoreSpec
InstantViVMOriginalLocationRecoverySpec
Instant Recovery to the original location with initial settings.
VmwareFcdInstantRecoveryMountsFilters
object
6 properties
EInstantViVMRecoveryMountsFiltersOrderColumn
string
Sorts mounts by one of the mount parameters.
EInstantVMRecoveryModeType
string
Restore mode.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

veeam-restore-api-openapi.yml Raw ↑

Other APIs Veeam publishes across the network.

Veeam Backup & Replication REST API
Veeam Backup Enterprise Manager REST API
Veeam Backup for Microsoft 365 REST API
Veeam ONE REST API
Veeam Backup for AWS REST API
Veeam Backup for Microsoft Azure REST API
Veeam Backup for Google Cloud REST API
Veeam Recovery Orchestrator REST API
Veeam Agents API
Veeam AmazonConnections API
Veeam Automation API
Veeam Backup Objects API
Where this information came from

This is an independent, third-party profile of Veeam Restore API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.