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.

« Delete Datafeeds API Delete Jobs API »

› › ›

Delete Events from Calendar API

This API enables you to delete scheduled events from a calendar.

Request

DELETE _xpack/ml/calendars/<calendar_id>/events/<event_id>

Description

This API removes individual events from a calendar. To remove all scheduled events and delete the calendar, see the delete calendar API.

Path Parameters

calendar_id(required): (string) Identifier for the calendar.
event_id (required): (string) Identifier for the scheduled event. You can obtain this identifier by using the get calendar events API.

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 a scheduled event from the planned-outages calendar:

DELETE _xpack/ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st

When the event is removed, you receive the following results:

{
  "acknowledged": true
}

« Delete Datafeeds API Delete Jobs API »