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 APIedit
Instantiates a calendar.
Requestedit
PUT _xpack/ml/calendars/<calendar_id>
Descriptionedit
For more information, see Calendars and scheduled events.
Path Parametersedit
-
calendar_id
(required) - (string) Identifier for the calendar.
Request Bodyedit
-
description
- (string) A description of the calendar.
Authorizationedit
You must have manage_ml
, or manage
cluster privileges to use this API.
For more information, see
Security privileges.
Examplesedit
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": [] }