IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create filters API Delete datafeeds API »
Elastic Docs ›Elasticsearch Guide [8.18] ›REST APIs ›Machine learning anomaly detection APIs

Delete calendars API

edit
A newer version is available. Check out the latest documentation.

Delete calendars API

edit

New API reference

For the most up-to-date API details, refer to Machine learning anomaly detection APIs.

Deletes a calendar.

Request

edit

DELETE _ml/calendars/<calendar_id>

Prerequisites

edit

Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.

Description

edit

This API removes all scheduled events from the calendar then deletes the calendar.

Path parameters

edit
<calendar_id>
(Required, string) A string that uniquely identifies a calendar.

Examples

edit
resp = client.ml.delete_calendar(
    calendar_id="planned-outages",
)
print(resp)
response = client.ml.delete_calendar(
  calendar_id: 'planned-outages'
)
puts response
const response = await client.ml.deleteCalendar({
  calendar_id: "planned-outages",
});
console.log(response);
DELETE _ml/calendars/planned-outages

When the calendar is deleted, you receive the following results:

{
  "acknowledged": true
}
« Create filters API Delete datafeeds API »