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

Start a Failover Plan

You can start a failover plan with the specified ID.

Request

To start a failover plan, send the POST HTTPS request to the URL of the /FailoverPlans/{ID}/action resource.

HTTP Request

POST https://<Availability-Console>:1281/v2/FailoverPlans/{ID}/action

Request Headers

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

Request Body

In the request body, the client must send the start action property with the null value:

{"start":"null"}

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 response to an action.

Example Start a Failover Plan

The following example returns a response on a start action for a failover plan with ID 27a8baf5-179e-4eae-81d5-772aa2331562.

Request:

POST https://localhost:1281/v2/FailoverPlans/27a8baf5-179e-4eae-81d5-772aa2331562/action

 

Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>

 

Request Body:

{"start":"null"}

 

Response Code:

200 Success

 

Response Body:

"Action started."

Veeam Large Logo

Deployment Guide

Migration Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Evaluator's Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Evaluator's Guide for Enterprises

RESTful API Reference