Help Center
Choose product document...
Veeam Availability Orchestrator 2.0
REST API Reference

Disable Failover Plan

You can disable a failover plan with the specified ID.

Request

To disable a failover plan, send the HTTP POST request to the URL of the /FailoverPlans/{id}/Disable resource.

Disable Failover Plan Note:

If you disable a failover plan, you will not be able to run it. To run a failover plan, it must be ENABLED. For more information on states that a failover plan can acquire, see the Veeam Availability Orchestrator User Guide, section Running and Scheduling Failover Plans.

HTTP Request

POST https://<hostname>:<port>/v2/FailoverPlans/{id}/Disable

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/xml
  • text/json
  • 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.

Response

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.

Header

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/xml
  • text/json
  • application/json

Identifies the media type of the response body message.

Example Disable Failover Plan

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

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 Success

 

Response Body:

no content

Veeam Large Logo

User Guide

Deployment Guide

Group Management Guide

REST API Reference