IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Close jobs API Create datafeeds API »
Elastic Docs ›Elasticsearch Guide [7.0] ›X-Pack APIs ›Machine learning APIs

Create calendar API

edit

Create calendar API

edit

Instantiates a calendar.

Request

edit

PUT _ml/calendars/<calendar_id>

Description

edit

For more information, see Calendars and Scheduled Events.

Path Parameters

edit
calendar_id (required)
(string) Identifier for the calendar.

Request Body

edit
description
(string) A description of the calendar.

Authorization

edit

You must have manage_ml, or manage cluster privileges to use this API. For more information, see Security Privileges.

Examples

edit

The following example creates the planned-outages calendar:

PUT _ml/calendars/planned-outages

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

{
  "calendar_id": "planned-outages",
  "job_ids": []
}
« Close jobs API Create datafeeds API »