This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Delete datafeeds API Delete filters API »

› › ›

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>

Prerequisites

edit

Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.

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) A string that uniquely identifies a calendar.
<event_id>: (Required, string) Identifier for the scheduled event. You can obtain this identifier by using the get calendar events API.

Examples

edit

resp = client.ml.delete_calendar_event(
    calendar_id="planned-outages",
    event_id="LS8LJGEBMTCMA-qz49st",
)
print(resp)

response = client.ml.delete_calendar_event(
  calendar_id: 'planned-outages',
  event_id: 'LS8LJGEBMTCMA-qz49st'
)
puts response

const response = await client.ml.deleteCalendarEvent({
  calendar_id: "planned-outages",
  event_id: "LS8LJGEBMTCMA-qz49st",
});
console.log(response);

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

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

{
  "acknowledged": true
}

« Delete datafeeds API Delete filters API »