This is an archive version of the document. To get the most up-to-date information, see the current version.Run Restore
|
To run a restore plan, it must be ENABLED. For more information on states that a restore plan can acquire, see the Veeam Availability Orchestrator User Guide, section Running ans Scheduling Restore Plans. |
You can run a restore plan with the specified ID.
Request
To run a restore plan, send the HTTP POST request to the URL of the /RestorePlans/{id}/Run resource.
HTTP Request
POST https://<hostname>:<port>/v2/RestorePlans/{id}/Run |
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 |
| 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 start plan execution, you must use plan launch options. For more information on the parameters, see section Plan Launch Options.
{ "planLaunchOptions": { "restorePointRule": { "date": "2019-03-29T11:02:33.076Z", }, "executeChainedPlans": true, "recoveryLocationId": <recoveryLocationId> } } |
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 |
| Identifies the media type of the response body message. |
Example
The following example runs a restore plan with the ID b8517d70-028d-4740-a130-787e164a3d83. The recovery location ID is ad19ae02-2760-4b38-acee-e1d459b97555.
|
