IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create jobs API Delete datafeeds API »

› › ›

Delete calendar API

edit

Delete calendar API

edit

Deletes a calendar.

Request

edit

DELETE _ml/calendars/<calendar_id>

Description

edit

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

Path Parameters

edit

calendar_id (required): (string) Identifier for the calendar.

Authorization

edit

You must have manage_ml, or manage cluster privileges to use this API. For more information, see Security privileges].

Examples

edit

The following example deletes the planned-outages calendar:

DELETE _ml/calendars/planned-outages

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

{
  "acknowledged": true
}

« Create jobs API Delete datafeeds API »