Delete calendars API

Delete calendars API

Deletes a calendar.

Request

DELETE _ml/calendars/<calendar_id>

Prerequisites

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

Description

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

Path parameters

<calendar_id>

(Required, string) A string that uniquely identifies a calendar.

Examples

  1. DELETE _ml/calendars/planned-outages

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

  1. {
  2.   "acknowledged": true
  3. }