Delete calendar API

Deletes a calendar.

Request

DELETE _ml/calendars/<calendar_id>

Prerequisites

  • If the Elasticsearch security features are enabled, you must have manage_ml or manage cluster privileges to use this API. See Security privileges.

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

DELETE _ml/calendars/planned-outages

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

{
  "acknowledged": true
}