Help Center
Choose product document...
Veeam Availability Orchestrator 1.0
RESTful API Reference

Schedule Failover

You can create a schedule for a failover plan with the specified ID.


To schedule a time for a failover plan to execute, send the POST HTTPS request to the URL of the /FailoverPlans/{id}/Schedule resource:

HTTP Request

POST https://<hostname>:<port>/v1/FailoverPlans/{id}/Schedule

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

In the request body, to configure plan scheduling settings, you must send action-specific parameters. For more information on the parameters, see section Failover Plan Action Parameters.


"startTime": <DateTime>




"previousPlanId": <ID>



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.




The length of the response body.


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

Example Schedule Failover

The following example schedules the failover plan with the be0d799a-cd89-4fd5-b612-5973384a6704 ID.


POST https://uwin2012r2.n.local:9899/v1/FailoverPlans/be0d799a-cd89-4fd5-b612-5973384a6704/Schedule


Request Header:

Authorization: Bearer <Access-Token>


Request Body:

 "startTime": "2018-01-31T13:49:05.060Z"



200 Success


Response Body:

no content

Veeam Large Logo

User Guide

Deployment Guide

Categorization Guide

RESTful API Reference