delete-calendar.asciidoc 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. [role="xpack"]
  2. [testenv="platinum"]
  3. [[ml-delete-calendar]]
  4. === Delete calendar API
  5. ++++
  6. <titleabbrev>Delete calendar</titleabbrev>
  7. ++++
  8. Deletes a calendar.
  9. [[ml-delete-calendar-request]]
  10. ==== {api-request-title}
  11. `DELETE _ml/calendars/<calendar_id>`
  12. [[ml-delete-calendar-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. {stack-ov}/security-privileges.html[Security privileges].
  17. [[ml-delete-calendar-desc]]
  18. ==== {api-description-title}
  19. This API removes all scheduled events from the calendar then deletes the
  20. calendar.
  21. [[ml-delete-calendar-path-parms]]
  22. ==== {api-path-parms-title}
  23. `<calendar_id>`::
  24. (Required, string) Identifier for the calendar.
  25. [[ml-delete-calendar-example]]
  26. ==== {api-examples-title}
  27. The following example deletes the `planned-outages` calendar:
  28. [source,js]
  29. --------------------------------------------------
  30. DELETE _ml/calendars/planned-outages
  31. --------------------------------------------------
  32. // CONSOLE
  33. // TEST[skip:setup:calendar_outages]
  34. When the calendar is deleted, you receive the following results:
  35. [source,console-result]
  36. ----
  37. {
  38. "acknowledged": true
  39. }
  40. ----