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 »

› › ›

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 and Machine learning security privileges.

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
}

« Create filter API Delete datafeeds API »