Veeam Availability Orchestrator 3.0
REST API Reference
Related documents

Run Failover

[Applies only to replica and storage plans]

You can run failover for a plan with the specified ID.

Request

To fail over a plan, send the HTTP POST request to the  /Plans/{planId}/Failover endpoint.

HTTP Request

POST https://<hostname>:<port>/api/v3/Plans/{planId}/Failover

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.

Content-Type

Required

application/json

Identifies a media type that is used in the body of the request.

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.

Request Body

To run failover for a plan, you must send the following specific parameters:

Parameter

Type

Description

executeChainedPlans

boolean

Defines whether VAO will run other plans scheduled in chain after the currently processed plan.

restorePointDate

string

Defines the restore point date to be used to restore VM replicas.

Note: Use null value to use the latest restore point.

protectStorageVolumes

boolean

Defines whether VAO will protect target storage volumes after failover process is complete.

In the request body, specify parameter values.

{

 "executeChainedPlans": true/false,

 "restorepointDate": "YYYY-MM-DDT00:00:00",

 "protectStorageVolumes": true/false

}

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns 200 response code.

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.

Run FailoverExample

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

Request:

POST https://uwin2012r2.n.local:9898/api/v3/Plans/b8517d70-028d-4740-a130-787e164a3d83/Failover

 

Request Header:

Authorization: Bearer <Access-Token>
Content-Type: application/json

 

Request Body:

{

 "executeChainedPlans": true,

 "restorepointDate": "2020-07-12T17:00:00",

 "protectStorageVolumes": true

}

 

Response:

200

 

Response Body:

{

 "success": true,

 "data": {}

}

This Document Help Center
User GuideGroup Management GuideREST API ReferenceVeeam Backup & Replication DocumentationVeeam ONE Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.