Create calendar API

Instantiates a calendar.

Request

PUT _ml/calendars/<calendar_id>

Prerequisites

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

Description

For more information, see Calendars and scheduled events.

Path parameters

<calendar_id>
(Required, string) Identifier for the calendar.

Request body

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

Examples

PUT _ml/calendars/planned-outages

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

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