Help Center
Choose product document...
Veeam Availability Orchestrator 2.0
REST API Reference

Run Failback

You can start the replica failback process for a plan with the specified ID.

Request

To switch from VM replicas back to original VMs, send the HTTP POST request to the URL of the /FailoverPlans/{id}/Run resource.

HTTP Request

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

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

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

To start plan execution in this mode, you must also use action-specific parameters. For more information on the parameters, see section Plan Launch Options.

{

"mode": "Failback"

 "planLaunchOptions": {

   "failbackRestoreVMTags": true,

   "recoveryLocationId": <recoveryLocationId>

 }

}

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

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.

Example Run Failback

The following example performs failback for a plan with the ID b8517d70-028d-4740-a130-787e164a3d83 to a recovery location with the ID ad19ae02-2760-4b38-acee-e1d459b97555.

Request:

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

 

Request Header:

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

 

Request Body:

{

"mode": "Failback"

 "planLaunchOptions": {

   "failbackRestoreVMTags": true,

   "recoveryLocationId": " ad19ae02-2760-4b38-acee-e1d459b97555"

 }

}

 

Response:

200 Success

 

Response Body:

no content

Veeam Large Logo

User Guide

Deployment Guide

Group Management Guide

REST API Reference