Start a Failover Plan

In this article

    You can start a failover plan with the specified ID.


    To start a failover plan, send the POST HTTPS request to the URL of the /failoverPlans/{ID}/action resource.

    HTTP Request

    POST https://<hostname>:1281/v2/failoverPlans/{ID}/action

    Request Headers

    The request header must contain the authorization token.

    Request Body

    In the request body, the client must send the start action property with the null value:

    {"start": null}


    The server returns the following response to the client.

    Response Code

    A successfully completed operation returns response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTP headers.




    The length of the response body.


    The media type and syntax of the request body message: application/json; charset=utf-8

    Response Body

    In the response body, Veeam Service Provider Console returns a response to an action.

    Example Start a Failover Plan

    The following example returns a response on a start action for a failover plan with ID 27a8baf5-179e-4eae-81d5-772aa2331562.


    POST https://localhost:1281/v2/failoverPlans/27a8baf5-179e-4eae-81d5-772aa2331562/action


    Request Header:

    Content-Type: application/json

    Authorization: Bearer <Access-Token>


    Request Body:

    {"start": null}


    Response Code:

    200 Success


    Response Body:

    "Action started."