WARNING: Version 6.2 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Create Jobs API Delete Datafeeds API »

› › ›

Delete Calendar API

This API enables you to delete a calendar.

Request

DELETE _xpack/ml/calendars/<calendar_id>

Description

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

Path Parameters

calendar_id (required): (string) Identifier for the calendar.

Authorization

You must have manage_ml, or manage cluster privileges to use this API. For more information, see Security Privileges.

Examples

The following example deletes the planned-outages calendar:

DELETE _xpack/ml/calendars/planned-outages

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

{
  "acknowledged": true
}

« Create Jobs API Delete Datafeeds API »