Delete Calendar API

Deletes a calendar.

Request

DELETE _xpack/ml/calendars/<calendar_id>

Description

This API removes all scheduled events from the calendar then deletes the calendar.

Path Parameters

calendar_id (required)
(string) Identifier for the calendar.

Authorization

You must have manage_ml, or manage cluster privileges to use this API. For more information, see Security privileges.

Examples

The following example deletes the planned-outages calendar:

DELETE _xpack/ml/calendars/planned-outages

When the calendar is deleted, you receive the following results:

{
  "acknowledged": true
}