Delete a calendar Generally available; Added in 6.2.0

DELETE /_ml/calendars/{calendar_id}

Remove all scheduled events from a calendar, then delete it. ##Required authorization

  • Cluster privileges: manage_ml

Path parameters

  • calendar_id string Required

    A string that uniquely identifies a calendar.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • acknowledged boolean Required

      For a successful response, this value is always true. On failure, an exception is returned instead.
DELETE /_ml/calendars/{calendar_id} 
DELETE _ml/calendars/planned-outages

curl \
 --request DELETE 'http://api.example.com/_ml/calendars/{calendar_id}'
Response examples (200)
A successful response when deleting a calendar. 
{
  "acknowledged": true
}

Documentation preview

This is a preview of your version @2025-06-09 which is not yet released.

View current documentation