Create Calendar API

Instantiates a calendar.

Request

PUT _xpack/ml/calendars/<calendar_id>

Description

For more information, see Calendars and scheduled events.

Path Parameters

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

Request Body

description
(string) A description of the calendar.

Authorization

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

Examples

The following example creates the planned-outages calendar:

PUT _xpack/ml/calendars/planned-outages

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

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