mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-30 10:23:41 -04:00
60 lines
1.5 KiB
Text
60 lines
1.5 KiB
Text
[role="xpack"]
|
|
[[ml-delete-calendar-event]]
|
|
= Delete events from calendar API
|
|
++++
|
|
<titleabbrev>Delete events from calendar</titleabbrev>
|
|
++++
|
|
|
|
.New API reference
|
|
[sidebar]
|
|
--
|
|
For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs].
|
|
--
|
|
|
|
Deletes scheduled events from a calendar.
|
|
|
|
[[ml-delete-calendar-event-request]]
|
|
== {api-request-title}
|
|
|
|
`DELETE _ml/calendars/<calendar_id>/events/<event_id>`
|
|
|
|
[[ml-delete-calendar-event-prereqs]]
|
|
== {api-prereq-title}
|
|
|
|
Requires the `manage_ml` cluster privilege. This privilege is included in the
|
|
`machine_learning_admin` built-in role.
|
|
|
|
[[ml-delete-calendar-event-desc]]
|
|
== {api-description-title}
|
|
|
|
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>>.
|
|
|
|
[[ml-delete-calendar-event-path-parms]]
|
|
== {api-path-parms-title}
|
|
|
|
`<calendar_id>`::
|
|
(Required, string)
|
|
include::{es-ref-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
|
|
|
|
`<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>>.
|
|
|
|
[[ml-delete-calendar-event-example]]
|
|
== {api-examples-title}
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE _ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st
|
|
--------------------------------------------------
|
|
// TEST[skip:catch:missing]
|
|
|
|
When the event is removed, you receive the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
----
|