IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create filter API Delete datafeeds API »
Elastic Docs ›Elasticsearch Guide [7.3] ›REST APIs ›Machine learning anomaly detection APIs

Delete calendar API

edit

Delete calendar API

edit

Deletes a calendar.

Request

edit

DELETE _ml/calendars/<calendar_id>

Prerequisites

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

Description

edit

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

Path parameters

edit
<calendar_id>
(Required, string) Identifier for the calendar.

Examples

edit

The following example deletes the planned-outages calendar:

DELETE _ml/calendars/planned-outages

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

{
  "acknowledged": true
}
« Create filter API Delete datafeeds API »