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

« Create anomaly detection jobs API Create datafeeds API »

› › ›

Create calendar API

edit

Create calendar API

edit

Instantiates a calendar.

Request

edit

PUT _ml/calendars/<calendar_id>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have manage_ml or manage cluster privileges to use this API. See Security privileges.

Description

edit

For more information, see Calendars and scheduled events.

Path parameters

edit

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

Request body

edit

description: (Optional, string) A description of the calendar.

Examples

edit

PUT _ml/calendars/planned-outages

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

{
  "calendar_id": "planned-outages",
  "job_ids": []
}

« Create anomaly detection jobs API Create datafeeds API »