Help Center
Choose product document...
Veeam Availability Orchestrator 2.0
REST API Reference

Failover Plans

The /FailoverPlans resource collection represents all created failover plans. The collection includes resources which represent individual plans and have specific system IDs.

Failover Plans Note:

A range of data available to a client in VAO REST API depends on permissions of the account under which the client is currently logged in.

Collection URL

The resource collection is located at the following URL:


Collection Representation Failover Plans



   "name": "Test DR Plan",

   "id": "ba58fa43-cfc8-49e4-8f30-ee970f82e738",

   "contactName": "Wendy May",

   "contactEmail": "",

   "contactTel": "18003334455",

   "description": "with uCentOS",

   "planState": "Failover",

   "planStateDetails": "Complete, no errors, no warnings",

   "planInUse": false,

   "scheduleEnabled": true,

   "scheduleType": "OnTime",

   "scheduleAfter": "",

   "scheduleAfterPlanName": "",

   "scheduleTime": "2017-07-11T05:58:49",

   "siteScopeId": "67c365b0-2c2a-4f45-a4de-6632b56d2e9c",

   "targetRPO": 1440,

   "targetRTO": 60,

   "_links": {

     "self": {

       "href": "/v2/FailoverPlans/ba58fa43-cfc8-49e4-8f30-ee970f82e738"





Veeam Large Logo

User Guide

Deployment Guide

Group Management Guide

REST API Reference