› › ›

Delete calendars API

Deletes a calendar.

Request

DELETE _ml/calendars/<calendar_id>

Prerequisites

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

Description

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

Path parameters

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

Examples

DELETE _ml/calendars/planned-outages

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

{
  "acknowledged": true
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/ml-delete-calendar.html