Delete events from calendar API

Deletes scheduled events from a calendar.

Request

DELETE _ml/calendars/<calendar_id>/events/<event_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 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.

Examples

The following example deletes a scheduled event from the planned-outages calendar:

DELETE _ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st

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

{
  "acknowledged": true
}