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

Get Failover Plans

You can get a representation of a collection of failover plans configured by tenants.

Request

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

HTTPS Request

GET https://<Availability-Console>:1281/v2/FailoverPlans

Request Headers

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

Response

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.

Header

Description

Content-length

The length of the response body.

Content-type

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 collection.

Example Get Failover Plans

The following request returns a representation of all failover plans configured by tenants.

Request:

GET https://localhost:1281/v2/FailoverPlans

 

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": [

     "start",

     "undo"

   ],

   "_links": {

     "self": {

       "href": "https://vac.tech.local:1281/v2/failoverPlans/7c3e7a76-d630-441e-aedf-1a715f21c181"

     },

     "tenants": {

       "href": "https://vac.tech.local:1281/v2/tenants/2"

     },

     "locations": {

       "href": "https://vac.tech.local:1281/v2/tenants/2/locations/2"

     }

   }

 },

 {

   "id": "9db53527-76ae-4c7e-b998-edc8fbd5fed8",

   "name": "Sandbox Failover to Cloud",

   "serverName": "vac",

   "vmCount": 1,

   "type": "Cloud",

   "state": "Ready",

   "actions": [

     "start",

     "undo"

   ],

   "_links": {

     "self": {

       "href": "https://vac.tech.local:1281/v2/failoverPlans/9db53527-76ae-4c7e-b998-edc8fbd5fed8"

     },

     "tenants": {

       "href": "https://vac.tech.local:1281/v2/tenants/2"

     }

   }

 }

]

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