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

Enable Failover Plan

Enable Failover Plan Note:

To run a failover plan, it must be ENABLED. For more information on states that a failover plan can acquire, see the Veeam Availability Orchestrator User Guide.

You can enable a failover plan with the specified ID.

Request

To enable a failover plan, send the POST HTTPS request to the URL of the /FailoverPlans/{id}/Enable resource:

HTTP Request

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

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

Example Enable Failover Plan

The following example enables the failover plan with the with the be0d799a-cd89-4fd5-b612-5973384a6704 ID.

Request:

POST https://uwin2012r2.n.local:9899/v1/FailoverPlans/be0d799a-cd89-4fd5-b612-5973384a6704/Enable

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 Success

 

Response Body:

no content

Veeam Large Logo

User Guide

Deployment Guide

Categorization Guide

RESTful API Reference