Create calendars API

Create calendars API

Instantiates a calendar.

Request

PUT _ml/calendars/<calendar_id>

Prerequisites

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

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

  1. PUT _ml/calendars/planned-outages

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

  1. {
  2.   "calendar_id": "planned-outages",
  3.   "job_ids": []
  4. }