This is an archive version of the document. To get the most up-to-date information, see the current version.Get Collection of Failover Plans
You can get a list of all created failover plans.
Request
To retrieve a representation of a collection of failover plans, send the GET HTTPS request to the URL of the /FailoverPlans collection.
HTTPS Request
GET https://<hostname>:<port>/v1/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, VAO returns a representation of the /FailoverPlans collection.
Example 
The following request returns a full list of failover plans.
Request: GET https://uwin2012r2.n.local:9899/v1/FailoverPlans
Request Header: Authorization: Bearer <Access-Token>
Response: 200 Success
Response Body: [ { "name": "Exchange FP", "id": "395f865b-c111-4729-8813-913304d0cb94", "contactName": "John Smith", "contactEmail": "john.smith@veeam.com", "contactTel": "18002223344", "description": "With uwin2012r2NL", "planState": "Enabled", "scheduleEnabled": false, "scheduleType": null, "scheduleAfter": null, "scheduleTime": null, "siteId": "0656efb6-70a8-44da-8b47-ab263bba1206", "_links": { "self": { "href": "/v1/FailoverPlans/395f865b-c111-4729-8813-913304d0cb94" } } }, { "name": "Fileservers FP", "id": "76da0d75-75b0-4675-8296-0142ad0d52a7", "contactName": "Wendy May", "contactEmail": "wendy.may@veeam.com", "contactTel": "18003334455", "description": "Placed on the uwin2012r2lt", "planStateDetails": "Complete, no errors, no warnings", "scheduleEnabled": false, "scheduleType": null, "scheduleAfter": null, "scheduleAfterPlanName": null, "scheduleTime": null, "siteId": "6d0615f9-0857-400f-afbb-59ad5616135a", "_links": { "self": { "href": "/v1/FailoverPlans/76da0d75-75b0-4675-8296-0142ad0d52a7" } } } ] |
