Changelog

This section describes the latest changes and features introduced in the Orchestrator REST API v13.1.

New Resource Collections

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.

New Operations

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.

Resource Changes

The following changes in the REST API schemas were made:

  • The RecoveryPlanInfo schema:
    • Added the MalwareError and MalwareWarning enum values to the currentRunResult and currentTestResult properties .
    • Removed the MalwareIssue enum value from the currentCheckResult, currentRunResult and currentTestResult properties.
  • The PlanRuntimeDetails schema:
    • Added the malwareIssues property.
    • Removed the MalwareIssue enum value from the executionResult property.
  • The DetailedInfo schema:
    • Added the isMalwareIssue property.
  • The TaskExecutionResult schema:
    • Added the malwareResult property.
    • Removed the RecoveryPlanInfo schema.
  • The StepRuntimeDetails schema:
    • Added the malwareIssues property.
    • Removed the MalwareIssue enum value from the executionResult property.

Deprecated Resources

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.