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

Run Failover

Run Failover 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 run a failover plan with the specified ID.


To fail over VMs in a plan to their replicas, send the POST HTTPS request to the URL of the /FailoverPlans/{id}/Run resource:

HTTP Request

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

Request Headers

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

Request Body

In the request body, you must send the mode parameter with the "FailoverNow" value.

To start plan execution, you must also use action-specific parameters. For more information on the parameters, see section Failover Plan Action Parameters.


"mode": "FailoverNow",

"planlaunchOptions": {

  "restorePointRule": {

    "date": "<Date>"

    "mode": "<Mode>"


  "executeChainedPlans": true/false




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.




The length of the response body.


The media type and syntax of the request body message: application/json; charset=utf-8

Example Run Failover

The following example runs the failover plan with the b8517d70-028d-4740-a130-787e164a3d83 ID.


POST https://uwin2012r2.n.local:9899/v1/FailoverPlans/b8517d70-028d-4740-a130-787e164a3d83/Run


Request Header:

Authorization: Bearer <Access-Token>


Request Body:

 "mode": "FailoverNow",
 "planLaunchOptions": {
    "restorePointRule": {
     "date": "2018-01-31T13:21:54.456Z",
     "mode": "NearestBefore"
   "executeChainedPlans": false



200 Success


Response Body:

no content

Veeam Large Logo

User Guide

Deployment Guide

Categorization Guide

RESTful API Reference