Delete a calendar Generally available

DELETE /_ml/calendars/{calendar_id}
Api key auth

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 
resp = client.ml.delete_calendar( calendar_id="planned-outages", )
const response = await client.ml.deleteCalendar({ calendar_id: "planned-outages", });
response = client.ml.delete_calendar( calendar_id: "planned-outages" )
$resp = $client->ml()->deleteCalendar([ "calendar_id" => "planned-outages", ]);
curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/calendars/planned-outages"
Response examples (200)
A successful response when deleting a calendar. 
{ "acknowledged": true }