Help Center
Choose product document...
Veeam Availability Orchestrator 1.0
RESTful 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.

Collection URL

The resource collection is located at the following URL:

https://<hostname>:<port>/v1/FailoverPlans

Collection Representation Failover Plans

[

 {

   "name": "Test DR Plan",

   "id": "ed1e67cf-f059-4722-bf2e-08f016d0b7b8",

   "contactName": "Wendy May",

   "contactEmail": "wendy.may@veeam.com",

   "contactTel": "18003334455",

   "description": "with uCentOS",

   "planState": "Disabled",
   "planStateDetails": "Never checked or tested",

   "scheduleEnabled": false,

   "scheduleType": null,

   "scheduleAfter": null,
   "scheduleAfterPlanName": null,

   "scheduleTime": null,

   "siteId": "395f865b-c111-4729-8813-913304d0cb94",

   "_links": {

     "self": {

       "href": "/v1/FailoverPlans/ed1e67cf-f059-4722-bf2e-08f016d0b7b8"

     }

   }

 },

 {

   "name": "Webserver Failover Plan",

   "id": "8024a22f-219c-4a48-8a7c-866944bf7910",

   "contactName": "John Smith",

   "contactEmail": "john.smith@veeam.com",

   "contactTel": "18002223344",

   "description": "With uwin2012r2NL",

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

   "scheduleEnabled": false,

   "scheduleType": null,

   "scheduleAfter": null,
   "scheduleAfterPlanName": null,

   "scheduleTime": null,

   "siteId": "395f865b-c111-4729-8813-913304d0cb94",

   "_links": {

     "self": {

       "href": "/v1/FailoverPlans/8024a22f-219c-4a48-8a7c-866944bf7910"

     }

   }

 }

]

 

In This Section:

Veeam Large Logo

User Guide

Deployment Guide

Categorization Guide

RESTful API Reference