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
ormanage
cluster privileges to use this API. See Security privileges and Machine learning security privileges.
Description
For more information, see Calendars and scheduled events.
Path parameters
<calendar_id>
(Required, string) A string that uniquely identifies a 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": []
}