POST /cloud/cloudFailoverPlans/{ID}?action=start
Starts a cloud failover plan that has the specified ID.
Request
To start a cloud failover plan, send the POST HTTP request to the /cloud/cloudFailoverPlans/{ID}?action=start URL.
HTTP Request
POST https://<Enterprise-Manager>:9398/api/cloud/cloudFailoverPlans/{ID}?action=start |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security. |
Content-Type | True | Identifies the format of the request body message. Possible values:
|
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
In the request body, the client must send the parameters for the started cloud failover plan. The body of the request must conform to the XML Schema Definitionem_rest_ of Veeam Backup Enterprise Manager REST API.
Important |
If you use the XML media type, make sure that the order of parameters in the request body is correct. For details, see request body examples in this section. |
The request body must contain either of the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
StartNow | Boolean | If you specify this parameter, Veeam Backup & Replication will fail over VMs added to the cloud failover plan to their latest restore points. | No | 0/1 |
StartDate | DateTime | If you specify this parameter, Veeam Backup & Replication will fail over VMs added to the cloud failover plan to the most recent restore points that were created prior to the selected date. | No | 0/1 |
For example:
<?xml version="1.0" encoding="utf-8"?> |
JSON Representation
{ "StartNow": true, "StartDate": "2015-12-29T15:13:37.7418767Z" } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 202 Accepted.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message. Possible values:
|
Response Body
In the response body, the REST API returns a task. Additionally, the REST API returns a URL to the task deletion operation. To stop the task execution, send the DELETE /task/{ID} request to the URL.
The task is created to start a cloud failover session. To track the status of the operation, send the GET /tasks/{ID} request.
The task with the Finished state contains a link to an entity representation of the cloud failover session. To track the session state, send the GET /cloud/failoverSessions/{ID} request.
Example
The example below starts a cloud failover plan that has ID e7ca6822-a87f-443d-8aae-8005970543bf and fails over VMs to their latest restore points.
Request: POST https://localhost:9398/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf?action=start
Request Headers: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Request Body: <?xml version="1.0" encoding="utf-8"?>
Response: 202 Accepted
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1"> |
To track the state of the received task, send the GET HTTP request to the URL of the task resource:
Request: GET https://localhost:9398/api/tasks/task-1
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1"> |
To track the state of the received cloud failover session, send the GET HTTP request to the session URL:
Request: GET https://localhost:9398/api/cloud/failoverSessions/a986d473-0248-4884-9832-17ec982ee393?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <CloudFailoverSession xmlns="http://www.veeam.com/ent/v1.0" Type="CloudFailoverSession" Href="https://localhost:9398/api/cloud/failoverSessions/a986d473-0248-4884-9832-17ec982ee393?format=Entity" Name="ABC Company Failover Plan" UID="urn:veeam:CloudFailoverSession:a986d473-0248-4884-9832-17ec982ee393"> |