Start Failover Plan

You can start a failover plan with the specified UID.

Required Privileges

To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.

Request

To start a failover plan, send the POST HTTP request to the URL of the /infrastructure/backupServers/failoverplans/{planUid}/start resource. Additionally you must create a query string that contains start date and end date timestamps in the yyyy-MM-ddTHH:mm:ss.fffffffK format to limit searched items.

HTTP Request

POST https://<hostname>:1280/api/v3/infrastructure/backupServers/failoverplans/{planUid}/start?dateTime={date-time}

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.

Accept

Optional

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 parameters

A list of parameters that are applicable for this operation:

Name

In

Type

Required

Default

Description

planUid

Path

String (uuid)

Yes

Failover plan UID

dateTime

Query

String/date

Date string is formatted as date-time according to RFC 3339.

No

Date and time of a failover start

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns positive response code 200 OK when the collection task is added to the internal queue and not when the task is executed.

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/json; charset=utf-8

Example Start Failover Plan

The following request starts a failover plan with UID 304c08c2-0d13-4e9d-b26b-0bd5add83b3b.

Request:

POST https://localhost:1280/api/v3/infrastructure/backupServers/failoverPlan/304c08c2-0d13-4e9d-b26b-0bd5add83b3b/start?dateTime=2020-03-30T03:47:20.784655+03:00

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response Code:

200 OK

I want to report a typo

There is a misspelling right here:

 

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