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

Halt Failover

You can interrupt execution of a failover plan with the specified ID.


To stop processing of a failover plan, send the POST HTTPS request to the URL of the /FailoverPlans/{id}/Halt resource:

HTTP Request

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

Request Headers

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

Request Body

In the request body, if you want to interrupt execution of other failover plans scheduled in chain after the plan, you must send the fullstop parameter with the "true" value.


"fullstop": true



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

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


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


Request Header:

Authorization: Bearer <Access-Token>


Request Body:


"fullstop": true




200 Success


Response Body:

no content

Veeam Large Logo

User Guide

Deployment Guide

Categorization Guide

RESTful API Reference