Veeam Availability Orchestrator 3.0
REST API Reference
Related documents

Continue Plan Execution

You can run a HALTED plan with the specified ID.

Request

To resume the plan execution process, send the HTTP POST request to the /Plans/{planId}/Continue endpoint.

HTTP Request

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

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

To resume a HALTED plan, you must send the following specific parameter:

Parameter

Type

Description

executionContinueOptions

string

Defines whether the plan execution will proceed from the next VM (ProceedToNextVm) or VM group included in the plan (ProceedToNextGroup), proceed from the next plan step (ProceedToNextStep), retry the failed step (RetryFailedStep), retry the failed VM (RetryFailedVm) or VM group (RetryFailedGroup).

In the request body, specify the parameter value.

{

"executionContinueOptions": "<Options>"

}

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.

Continue Plan ExecutionExample

The following example continues execution of a plan with the ID b8517d70-028d-4740-a130-787e164a3d83 from the failed step.

Request:

POST https://uwin2012r2.n.local:9898/api/v3/Plans/b8517d70-028d-4740-a130-787e164a3d83/Run/Continue

 

Request Header:

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

 

Request Body:

{

"executionContinueOptions": "RetryFailedStep"

}

 

Response:

200

 

Response Body:

{

 "success": true,

 "data": {}

}

This Document Help Center
User GuideGroup Management GuideREST API ReferenceVeeam Backup & Replication DocumentationVeeam ONE Documentation
I want to report a typo

There is a misspelling right here:

 

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