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

Reset Failover Plan

You can reset a failover plan with the specified ID.


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

HTTP Request

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

Request Headers

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

Request Body

In the request body, to define whether to reset the plan state, clear the change log history or reset the whole plan configuration, you must send action-specific parameters. For more information on the parameters, see section Failover Plan Action Parameters.


"resetState": true/false

"resetConfiguration": true/false

"resetChangeLog": true/false



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 Reset Failover Plan

The following example resets the state 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/Reset


Request Header:

Authorization: Bearer <Access-Token>


Request Body:


"resetState": true




200 Success


Response Body:

no content

Veeam Large Logo

User Guide

Deployment Guide

Categorization Guide

RESTful API Reference