Delete calendars API

edit

Deletes a calendar.

Request

edit

DELETE _ml/calendars/<calendar_id>

Prerequisites

edit

Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.

Description

edit

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

Path parameters

edit
<calendar_id>
(Required, string) A string that uniquely identifies a calendar.

Examples

edit
DELETE _ml/calendars/planned-outages

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

{
  "acknowledged": true
}