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

Run Permanent Failover

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.


To finalize failover to VM 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 "PermanentFailoverNow" value.


"mode": "PermanentFailoverNow"



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

The following example performs permanent failover for the 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": "PermanentFailoverNow"




200 Success


Response Body:

no content

Veeam Large Logo

User Guide

Deployment Guide

Categorization Guide

RESTful API Reference