Create calendars APIedit

Instantiates a calendar.

Requestedit

PUT _ml/calendars/<calendar_id>

Prerequisitesedit

Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.

Descriptionedit

For more information, see Calendars and scheduled events.

Path parametersedit

<calendar_id>
(Required, string) A string that uniquely identifies a calendar.

Request bodyedit

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

Examplesedit

PUT _ml/calendars/planned-outages

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

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