Undo Plan

[Applies only to replica and storage plans]

You can perform an undo operation for a storage plan in the HALTED state and for a replica plan in the FAILOVER, FAILBACK and HALTED states. For more information on states that a VAO plan can acquire, see the Veeam Availability Orchestrator User Guide, sections Running and Scheduling Replica Plans, Running and Scheduling Storage Plans.

Tip

Perform an undo operation for a plan, if you want:

  • To power off running VM replicas on target hosts and roll back to initial state of VM replicas. The plan must be in the FAILOVER state.
  • To switch from production VMs back to VM replicas. The plan must be in the FAILBACK state.
  • To undo all previously performed operations. The plan must be in the HALTED state.

Request

To perform an undo operation for a plan, send the HTTP POST request to the /Plans/{planId}/Undo endpoint.

HTTP Request

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

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.

Undo PlanExample

The following example performs an undo operation for a plan with the ID ed1e67cf-f059-4722-bf2e-08f016d0b7b8.

Request:

POST https://uwin2012r2.n.local:9898/api/v3/Plans/ed1e67cf-f059-4722-bf2e-08f016d0b7b8/Undo

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "success": true,

 "data": {}

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.