delete-calendar-event.asciidoc 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  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>>.
  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) Identifier for the calendar.
  26. `<event_id>`::
  27. (Required, string) Identifier for the scheduled event. You can obtain this
  28. identifier by using the <<ml-get-calendar-event,get calendar events API>>.
  29. [[ml-delete-calendar-event-example]]
  30. ==== {api-examples-title}
  31. The following example deletes a scheduled event from the `planned-outages`
  32. calendar:
  33. [source,console]
  34. --------------------------------------------------
  35. DELETE _ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st
  36. --------------------------------------------------
  37. // TEST[skip:catch:missing]
  38. When the event is removed, you receive the following results:
  39. [source,js]
  40. ----
  41. {
  42. "acknowledged": true
  43. }
  44. ----