1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 |
- [role="xpack"]
- [testenv="platinum"]
- [[ml-delete-calendar]]
- === Delete calendar API
- ++++
- <titleabbrev>Delete calendar</titleabbrev>
- ++++
- Deletes a calendar.
- [[ml-delete-calendar-request]]
- ==== {api-request-title}
- `DELETE _ml/calendars/<calendar_id>`
- [[ml-delete-calendar-desc]]
- ==== {api-description-title}
- This API removes all scheduled events from the calendar then deletes the
- calendar.
- [[ml-delete-calendar-path-parms]]
- ==== {api-path-parms-title}
- `calendar_id` (required)::
- (string) Identifier for the calendar.
- [[ml-delete-calendar-prereqs]]
- ==== {api-prereq-title}
- You must have `manage_ml`, or `manage` cluster privileges to use this API.
- For more information, see {stack-ov}/security-privileges.html[Security privileges].
- [[ml-delete-calendar-example]]
- ==== {api-examples-title}
- The following example deletes the `planned-outages` calendar:
- [source,js]
- --------------------------------------------------
- DELETE _ml/calendars/planned-outages
- --------------------------------------------------
- // CONSOLE
- // TEST[skip:setup:calendar_outages]
- When the calendar is deleted, you receive the following results:
- [source,js]
- ----
- {
- "acknowledged": true
- }
- ----
- // TESTRESPONSE
|