- About Veeam Recovery Orchestrator REST API
- Overview
- Changelog
- Token
- Mfa
- Clients
- 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
- postClear Change Log History for Plan
- postRun Failover
- postRun Restore Plan
- postContinue Plan Execution
- postRun Readiness Check
- delDelete Plan Schedule
- putSchedule Plan to Run at Specific Time
- putSchedule Plan to Run After Another Plan
- postClone Plan
- RecoveryLocations
- RuntimeDetails
- Scopes
- LicenseUsage
This section describes the latest changes and features introduced in the Orchestrator REST API v7.21.
The following new operations were added to the existing resource collections in the Veeam Recovery Orchestrator REST API v7.21:
- HTTP POST
/api/v7.21/Mfa/GenerateMfaCode— generates an MFA secret code required to set up the authentication application.
The following changes in the REST API schemas were made:
- HTTP POST
/api/tokenrequest:- Added the
mfa_tokenrequired property to the request body. - Added the
mfa_passcoderequired property to the request body. - Added the
mfaenum value to thegrant_typerequired request property.
- Added the
The following changes in the REST API schemas were made:
The
AuthenticateResponseschema:- Added the
is_mfa_configuredandmfa_tokenoptional properties to the response body.
- Added the
The
GroupRuntimeDetailsschema:- Added the
HvVmJobenum value to thegroupCategoryproperty.
- Added the
The
AzureCloudRecoveryLocationInfoschema:- Removed the following properties:
computeAccountId,hardwareRules,isolatedNetworkId,isolatedSubnetId,physicalNetworkMappingRules,proxyIds,recoverAgentBackups,recoverVmBackups,regionId,regionType,repositoryRules,resourceGroupId,storageAccountId,subscriptionId,vbrServerId,virtualNetworkMappingRules.
- Removed the following properties:
The
HyperVRecoveryLocationInfoschema:- Removed the following properties:
clusterId,clusterName,enforceDataSovereignty,hyperVNetworkMappingRules,instantVmRestore,preferBackupCopy,scVmmId,scVmmName,storages,vmNetworkMappingRules.
- Removed the following properties:
The
RestoreRecoveryLocationInfoschema:- Removed the following properties:
computeGroups,cpuPressureThreshold,enforceDataSovereignty,instantVmRecovery,networkMappingRules,physicalNetworkMappingRules,preferBackupCopy,reIpRules,recoverAgentBackups,recoverVmBackups,storageGroups,storagePressureThreshold.
- Removed the following properties:
The
StorageRecoveryLocationInfoschema:- Removed the following properties:
computeGroups,datacenterId,datacenterName,networkMappingRules,reIpRules,storageSystems,vCenterId,vCenterName,vendor.
- Removed the following properties: