Help Center
Choose product document...
Veeam Availability Orchestrator 1.0
RESTful API Reference

Get Collection of Failover Plans

You can get a list of all created failover plans.


To retrieve a representation of a collection of failover plans, send the GET HTTPS request to the URL of the /FailoverPlans collection.

HTTPS Request

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

Request Headers

The request header must contain the authorization token for the current logon session.


The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.




The length of the response body.


The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, VAO returns a representation of the /FailoverPlans collection.

Example Get Collection of Failover Plans

The following request returns a full list of failover plans.


GET https://uwin2012r2.n.local:9899/v1/FailoverPlans


Request Header:

Authorization: Bearer <Access-Token>



200 Success


Response Body:



   "name": "Exchange FP",

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

   "contactName": "John Smith",

   "contactEmail": "",

   "contactTel": "18002223344",

   "description": "With uwin2012r2NL",

   "planState": "Enabled",
   "planStateDetails": "Failed check, 1 error, no warnings",

   "scheduleEnabled": false,

   "scheduleType": null,

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

   "scheduleTime": null,

   "siteId": "0656efb6-70a8-44da-8b47-ab263bba1206",

   "_links": {

     "self": {

       "href": "/v1/FailoverPlans/395f865b-c111-4729-8813-913304d0cb94"





   "name": "Fileservers FP",

   "id": "76da0d75-75b0-4675-8296-0142ad0d52a7",

   "contactName": "Wendy May",

   "contactEmail": "",

   "contactTel": "18003334455",

   "description": "Placed on the uwin2012r2lt",
   "planState": "Undo Failover",

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

   "scheduleEnabled": false,

   "scheduleType": null,

   "scheduleAfter": null,

   "scheduleAfterPlanName": null,

   "scheduleTime": null,

   "siteId": "6d0615f9-0857-400f-afbb-59ad5616135a",

   "_links": {

     "self": {

       "href": "/v1/FailoverPlans/76da0d75-75b0-4675-8296-0142ad0d52a7"





Veeam Large Logo

User Guide

Deployment Guide

Categorization Guide

RESTful API Reference