This is an archive version of the document. To get the most up-to-date information, see the current version.

(POST) /failoverPlans/{ID}?action=start

In this article

    Starts a failover plan having the specified ID.

    Request

    To start a failover plan, you need to send the POST HTTP request to the /failoverPlans/{ID}?action=start URL.

    HTTP Request

    POST http://<Enterprise-Manager>:9399/api/failoverPlans/{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. To learn more, see Authentication and Security.

    Request Body

    In the request body, the client must send the parameters for the started failover plan. The body of the request must conform to the XML Schema Definitionem_rest_ of Veeam Backup Enterprise Manager RESTful API.

    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 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 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"?>
    <FailoverPlanManagementSpecType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <StartNow xmlns="http://www.veeam.com/ent/v1.0">true</StartNow>
     <StartDate xmlns="http://www.veeam.com/ent/v1.0">2014-10-18T14:21:20.172767Z</StartDate>
    </FailoverPlanManagementSpecType>

    Query Parameters

    None.

    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: application/xml.

    Response Body

    In the response body, Veeam Backup Enterprise Manager returns an ID of the task that has been created to perform the requested action, and the task state. You can check the operation results by sending the GET HTTP request to the URL of the task resource.

    Additionally, Veeam Backup Enterprise Manager returns a link to the task deletion operation. You can send the GET HTTP request to the URL in the link to stop the task execution.

    Example

    The example below starts a failover plan having ID ae01e36f-32a3-4095-95fa-09a2af744009 and fails over VMs to their latest restore points.

    Request:

    POST http://localhost:9399/api/failoverPlans/ae01e36f-32a3-4095-95fa-09a2af744009?action=start

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Request Body:

    <?xml version="1.0" encoding="utf-8"?>
    <FailoverPlanManagementSpecType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <StartNow xmlns="http://www.veeam.com/ent/v1.0">true</StartNow>
    </FailoverPlanManagementSpecType>

     

    Response:

    202 Accepted

     

    Response Body:

    <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
     <Links>
       <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
     </Links>
     <TaskId>task-1</TaskId>
     <State>Running</State>
     <Operation>StartFailoverPlan</Operation>
    </Task>

    To trace the status of the operation, send the GET HTTP request to the URL of the received task resource:

    Request:

    GET http://localhost:9399/api/tasks/task-1

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 Success

     

    Response Body:

    <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
     <Links>
       <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
     </Links>
     <TaskId>task-1</TaskId>
     <State>Finished</State>
     <Operation>StartFailoverPlan</Operation>
     <Result Success="true">
       <Message>Ok</Message>
     </Result>
    </Task>