NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Delete calendar API
editDelete calendar API
editDeletes a calendar.
Request
editDELETE _xpack/ml/calendars/<calendar_id>
Description
editThis API removes all scheduled events from the calendar then deletes the calendar.
Path Parameters
edit-
calendar_id
(required) - (string) Identifier for the calendar.
Authorization
editYou must have manage_ml
, or manage
cluster privileges to use this API.
For more information, see Security privileges.
Examples
editThe following example deletes the planned-outages
calendar:
DELETE _xpack/ml/calendars/planned-outages
When the calendar is deleted, you receive the following results:
{ "acknowledged": true }