IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Create calendar API
editCreate calendar API
editInstantiates a calendar.
Request
editPUT _ml/calendars/<calendar_id>
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have
manage_ml
ormanage
cluster privileges to use this API. See Security privileges.
Description
editFor 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
editPUT _ml/calendars/planned-outages
When the calendar is created, you receive the following results:
{ "calendar_id": "planned-outages", "job_ids": [] }