OpenSearch/docs/reference/ml/apis/delete-calendar-event.asciidoc

[role="xpack"]
[testenv="platinum"]
[[ml-delete-calendar-event]]
=== Delete Events from Calendar API
++++
<titleabbrev>Delete Events from Calendar</titleabbrev>
++++

Deletes 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
<<ml-delete-calendar,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 <<ml-get-calendar-event,get calendar events API>>.


==== Authorization

You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see {xpack-ref}/security-privileges.html[Security Privileges].

==== Examples

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

[source,js]
--------------------------------------------------
DELETE _xpack/ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st
--------------------------------------------------
// CONSOLE
// TEST[skip:catch:missing]

When the event is removed, you receive the following results:
[source,js]
----
{
  "acknowledged": true
}
----