- About Veeam Recovery Orchestrator REST API
- Overview
- Changelog
- Components
- LicenseUsage
- Mfa
- Plans
- getGet Collection of Plans
- getGet Plan Data
- getGet VMs Added to Inventory Group in Plan
- getGet All Groups in Plan
- getGet Parameters Configured for Step in Plan
- getGet Steps Added for VM in Plan
- getGet Steps Added to Virtual Group in Plan
- postEnable Plan
- postDisable Plan
- postHalt Plan
- postRun Permanent Failover
- postFail Back to Source VMs
- postPrepare for Failback
- postSwitchover to Production
- postCommit Failback
- postUndo Plan
- postReset Plan State
- postRun Failover
- postRun Restore Plan
- postContinue Plan Execution
- postRun Readiness Check
- postRun Malware Scan for Restore Plan
- delDelete Plan Schedule
- postSchedule Plan to Run on Schedule
- putSchedule Plan to Run After Another Plan
- postClone Plan
- RecoveryLocations
- RuntimeDetails
- Scopes
- Token
This section describes the latest changes and features introduced in the Orchestrator REST API v13.1.
The following new resource collections were introduced in the Veeam Recovery Orchestrator REST API v13.1:
/components— you can view the list of all infrastracture components added to Orchestrator.
The following new operations were added to the existing resource collections in the Veeam Recovery Orchestrator REST API v13.1:
- HTTP GET
/api/v13.1/Components/Credentials— retrieves credentials used to authenticate to the standalone Hyper-V host. - HTTP GET
/api/v13.1/Components/HyperV/DirectHosts— retrieves a a list of all standalone Hyper-V hosts added to the Orchestrator infrastructure. - HTTP POST
/api/v13.1/Components/HyperV/DirectHosts— adds a new standalone Hyper-V host to the Orchestrator infrastructure. - HTTP DELETE
/api/v13.1/Components/HyperV/DirectHosts/{directHostId— deletes the standalone Hyper-V host from the Orchestrator infrastructure. - HTTP GET
/api/v13.1/Components/HyperV/DirectHosts/{directHostId}/CsvDisks— retrieves a list of CSV disks available on a standalone Hyper-V host with the specified ID. - HTTP GET
/api/v13.1/Components/HyperV/DirectHosts/{directHostId}/Networks— retrieves a list of networks configured for a standalone Hyper-V host with the specified ID. - HTTP POST
/api/v13.1/RecoveryLocations/HyperV/DirectHost— creates a new Microsoft Hyper-V recovery location to restore VMs to a standalone Hyper-V host. - HTTP GET
/api/v13.1/RecoveryLocations/Azure/{id}— retrieves a representation of a Microsoft Azure recovery location with the specified ID. - HTTP GET
/api/v13.1/RecoveryLocations/Restore/{id}— retrieves a representation of a VMware vSphere recovery location with the specified ID. - HTTP GET
/api/v13.1/RecoveryLocations/Storage/{id}— retrieves a representation of a storage recovery location with the specified ID. - HTTP GET
/api/v13.1/RecoveryLocations/HyperV/{id}— retrieves a representation of a Microsoft Hyper-V recovery location with the specified ID. - HTTP DELETE
/api/v13.1/RecoveryLocations/{id}— deletes a recovery location with the specified ID.
The following changes in the REST API schemas were made:
- The
RecoveryPlanInfoschema:- Added the
MalwareErrorandMalwareWarningenum values to thecurrentRunResultandcurrentTestResultproperties . - Removed the
MalwareIssueenum value from thecurrentCheckResult,currentRunResultandcurrentTestResultproperties.
- Added the
- The
PlanRuntimeDetailsschema:- Added the
malwareIssuesproperty. - Removed the
MalwareIssueenum value from theexecutionResultproperty.
- Added the
- The
DetailedInfoschema:- Added the
isMalwareIssueproperty.
- Added the
- The
TaskExecutionResultschema:- Added the
malwareResultproperty. - Removed the
RecoveryPlanInfoschema.
- Added the
- The
StepRuntimeDetailsschema:- Added the
malwareIssuesproperty. - Removed the
MalwareIssueenum value from theexecutionResultproperty.
- Added the
The following endpoint is deprecated in the Veeam Recovery Orchestrator REST API v13.1. To use this endpoint, you must specify the v13 REST API version in the URL of an HTTP request.
- HTTP PUT
/Plans/{planId}/Schedule/SaveTime— schedules execution of a plan with the specified ID to run at a specific time. - HTTP GET
/RecoveryLocations/{id}— retrieves a representation of a recovery location with the specified ID.