Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

Get a Failover Plan

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


To get a resource representation of a failover plan, send the GET HTTPS request to the URL of its resource.

HTTP Request

GET https://<Availability-Console>:1281/v2/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, Veeam Availability Console returns a representation of the /FailoverPlans/{ID} resource.

Example Get a Failover Plan

The following example returns an entity representation of a failover plan with ID 7c3e7a76-d630-441e-aedf-1a715f21c181.


GET https://localhost:1281/v2/FailoverPlans/7c3e7a76-d630-441e-aedf-1a715f21c181


Request Header:

Authorization: Bearer <Access-Token>


Response Code:

200 Success


Response Body:


   "id": "7c3e7a76-d630-441e-aedf-1a715f21c181",

   "name": "Infrastructure Servers to Cloud",

   "serverName": "backup02",

   "vmCount": 3,

   "type": "Local",

   "state": "Ready",

   "actions": [




   "_links": {

     "self": {

       "href": ""


     "tenants": {

       "href": ""


     "locations": {

       "href": ""




Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference