Help Center
Choose product document...
Veeam Availability Orchestrator 2.0
REST API Reference

Get Collection of Failover Plans for VAO Scope

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

Request

To retrieve a representation of a collection of failover plans for a particular scope, send the HTTP GET request to the URL of the /FailoverPlans collection.

HTTP Request

GET https://<hostname>:<port>/v2/Sites/{siteid}/Scopes/{siteScopeId}/FailoverPlans

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Accept

optional

  • application/xml
  • text/json
  • application/json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

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

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/xml
  • text/json
  • application/json

Identifies the media type of the response body message.

Response Body

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

Example Get Collection of Failover Plans for VAO Scope

The following request returns a list of failover plans for a VAO scope with the ID 87da0cab-09f5-4b8f-bd3c-a346983c2930. The VAO server ID is 76da0d75-75b0-4675-8296-0142ad0d52a7.

Request:

GET https://uwin2012r2.n.local:9899/v2/Sites/76da0d75-75b0-4675-8296-0142ad0d52a7/Scopes/87da0cab-09f5-4b8f-bd3c-a346983c2930/FailoverPlans

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 Success

 

Response Body:

[

 {

   "name": "defFailover",

   "id": "b67b1f19-f930-4c2c-b2e9-61d3ccac3a48",

   "contactName": "Wendy May",

   "contactEmail": "wendy.may@veeam.com",

   "contactTel": "3232556666"

   "description": "Failover plan 2",

   "planState": "Failover",

   "planStateDetails": "Complete, no errors, 1 warning",

   "planInUse": false,

   "scheduleEnabled": false,

   "scheduleType": null,

   "scheduleAfter": null,

   "scheduleAfterPlanName": null,

   "scheduleTime": null,

   "siteScopeId": "87da0cab-09f5-4b8f-bd3c-a346983c2930",

   "targetRPO": 59940,

   "targetRTO": 60,

   "_links": {

     "self": {

       "href": "/v2/FailoverPlans/b67b1f19-f930-4c2c-b2e9-61d3ccac3a48"

     }

   }

 }

]

Veeam Large Logo

User Guide

Deployment Guide

Group Management Guide

REST API Reference