1
0

delete-calendar-event.asciidoc 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. [role="xpack"]
  2. [testenv="platinum"]
  3. [[ml-delete-calendar-event]]
  4. = Delete events from calendar API
  5. ++++
  6. <titleabbrev>Delete events from calendar</titleabbrev>
  7. ++++
  8. Deletes scheduled events from a calendar.
  9. [[ml-delete-calendar-event-request]]
  10. == {api-request-title}
  11. `DELETE _ml/calendars/<calendar_id>/events/<event_id>`
  12. [[ml-delete-calendar-event-prereqs]]
  13. == {api-prereq-title}
  14. * If the {es} {security-features} are enabled, you must have `manage_ml` or
  15. `manage` cluster privileges to use this API. See
  16. <<security-privileges>> and {ml-docs-setup-privileges}.
  17. [[ml-delete-calendar-event-desc]]
  18. == {api-description-title}
  19. This API removes individual events from a calendar. To remove all scheduled
  20. events and delete the calendar, see the
  21. <<ml-delete-calendar,delete calendar API>>.
  22. [[ml-delete-calendar-event-path-parms]]
  23. == {api-path-parms-title}
  24. `<calendar_id>`::
  25. (Required, string)
  26. include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
  27. `<event_id>`::
  28. (Required, string) Identifier for the scheduled event. You can obtain this
  29. identifier by using the <<ml-get-calendar-event,get calendar events API>>.
  30. [[ml-delete-calendar-event-example]]
  31. == {api-examples-title}
  32. [source,console]
  33. --------------------------------------------------
  34. DELETE _ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st
  35. --------------------------------------------------
  36. // TEST[skip:catch:missing]
  37. When the event is removed, you receive the following results:
  38. [source,js]
  39. ----
  40. {
  41. "acknowledged": true
  42. }
  43. ----