This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Create filters API Delete datafeeds API »

› › ›

Delete calendars API

edit

Delete calendars API

edit

Deletes a calendar.

Request

edit

DELETE _ml/calendars/<calendar_id>

Prerequisites

edit

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

Description

edit

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

Path parameters

edit

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

Examples

edit

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

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

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

DELETE _ml/calendars/planned-outages

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

{
  "acknowledged": true
}

« Create filters API Delete datafeeds API »