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

Delete events from calendar API

edit

Delete events from calendar API

edit

Deletes scheduled events from a calendar.

Request

edit

DELETE _ml/calendars/<calendar_id>/events/<event_id>

Description

edit

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

Path Parameters

edit
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

edit

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

Examples

edit

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
}
« Delete datafeeds API Delete filter API »