Delete calendars APIedit

Deletes a calendar.

Requestedit

DELETE _ml/calendars/<calendar_id>

Prerequisitesedit

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

Descriptionedit

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

Path parametersedit

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

Examplesedit

response = client.ml.delete_calendar(
  calendar_id: 'planned-outages'
)
puts response
DELETE _ml/calendars/planned-outages

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

{
  "acknowledged": true
}