Delete a calendar

Auth

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

Required privileges

calendar_id string required: A string that uniquely identifies a calendar.

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _ml/calendars/planned-outages

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.deleteCalendar({
  calendar_id: "planned-outages",
});

Python Elasticsearch Python Client

resp = client.ml.delete_calendar(
    calendar_id="planned-outages",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_ml/calendars/planned-outages" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().deleteCalendar(d -> d
    .calendarId("planned-outages")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.DeleteCalendarAsync(calendarId: "planned-outages");

PHP Elasticsearch PHP Client

$resp = $client->ml()->deleteCalendar([
    "calendar_id" => "planned-outages",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.delete_calendar(
  calendar_id: "planned-outages"
)

Response

A successful response when deleting a calendar.

{
  "acknowledged": true
}