Veeam Availability Orchestrator 3.0
REST API Reference
Related documents

Run Permanent Failover

[Applies only to replica plans]

You can start the permanent failover process for a plan with the specified ID. VM replicas on the target host will cease to exist as replicas and take on the role of original VMs.

Request

To finalize failover to VM replicas, send the HTTP POST request the /Plans/{planId}/PermanentFailover resource.

HTTP Request

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

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.

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.

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 Permanent FailoverExample

The following example performs permanent 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/PermanentFailover

 

Request Header:

Authorization: Bearer <Access-Token>

 

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.