Help Center
Choose product document...
Veeam Availability Orchestrator 2.0
REST API Reference

Halt Restore

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

Request

To stop processing of a restore plan, send the HTTP POST request to the URL of the /RestorePlans/{id}/Halt resource.

HTTP Request

POST https://<hostname>:<port>/v2/RestorePlans/{id}/Halt

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.

Content-Type

required

application/json

Identifies a media type that is used in the body of the request.

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.

Request Body

In the request body, to define whether VAO will interrupt the execution of other plans scheduled in chain after the halted plan, you must send action-specific parameters. For more information on the parameters, see section Restore Plan Action Parameters.

{

"fullstop": true/false

}

Response

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.

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.

Example Halt Restore

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

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>
Content-Type: application/json

 

Request Body:

{

"fullstop": true

}

 

Response:

200 Success

 

Response Body:

no content

Veeam Large Logo

User Guide

Deployment Guide

Group Management Guide

REST API Reference