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

Get Failover Plan Data

You can get a representation of a failover plan with the specified ID.


To retrieve a representation of a failover plan, send the GET HTTPS request to the URL of the /FailoverPlans/{id} resource:

HTTP Request

GET https://<hostname>:<port>/v1/FailoverPlans/{id}

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/{id} resource.

Example Get Failover Plan Data

The following example returns an entity representation for the VAO site with the 12f39f64-245e-4430-a82e-126497007641 ID.


GET https://uwin2012r2.n.local:9899/v1/FailoverPlans/12f39f64-245e-4430-a82e-126497007641


Request Header:

Authorization: Bearer <Access-Token>



200 Success


Response Body:



   "name": "Webserver Failover Plan",

    "id": "12f39f64-245e-4430-a82e-126497007641",

    "contactName": "Wendy May",

    "contactEmail": "",

    "contactTel": "18003334455",

    "description": "With uwin2012r2NL",

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

    "scheduleEnabled": false,

    "scheduleType": null,

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

    "scheduleTime": null,

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

    "_links": {

      "self": {

        "href": "/v1/FailoverPlans/12f39f64-245e-4430-a82e-126497007641"





Veeam Large Logo

User Guide

Deployment Guide

Categorization Guide

RESTful API Reference