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

Get Collection of Failover Plans for VAO Site

You can get a list of all failover plans created for a VAO site with the specified ID.


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

HTTPS Request

GET https://<hostname>:<port>/v1/Sites/{siteid}/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 /Sites/{siteid}/FailoverPlans collection.

Example Get Collection of Failover Plans for VAO Site

The following request returns a list of failover plans for the VAO site with the 6d0615f9-0857-400f-afbb-59ad5616135a ID.


GET https://uwin2012r2.n.local:9899/v1/Sites/6d0615f9-0857-400f-afbb-59ad5616135a/FailoverPlans


Request Header:

Authorization: Bearer <Access-Token>



200 Success


Response Body:



   "id": "b063f440-2f15-45aa-a8f7-196be6f652ba",

   "contactName": "Chloe Lewis",

   "contactEmail": "",

   "contactTel": "18004445566",

   "description": "with uCentOS",

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

   "scheduleEnabled": true,

   "scheduleType": "OnTime",

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

   "scheduleTime": "2017-09-08T08:30:00",

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

   "_links": {

     "self": {

       "href": "/v1/FailoverPlans/b063f440-2f15-45aa-a8f7-196be6f652ba"





Veeam Large Logo

User Guide

Deployment Guide

Categorization Guide

RESTful API Reference