Disable Schedule for Plan

You can disable a configured schedule for a plan with the specified ID.

Request

To disable a plan and return plan scheduling settings to default values, send the HTTP DELETE request to the /Plans/{planId}/Schedule endpoint.

HTTP Request

DELETE https://<hostname>:<port>/api/v3/Plans/{planId}/Schedule

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 204 response code.

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.

Disable Schedule for PlanExample

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

Request:

DELETE https://uwin2012r2.n.local:9898/api/v3/Plans/be0d799a-cd89-4fd5-b612-5973384a6704/Schedule

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

204

 

Response Body:

no content

I want to report a typo

There is a misspelling right here:

 

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