WARNING: Version 6.2 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

Elastic Docs ›Elasticsearch Reference [6.2] ›X-Pack APIs ›Machine Learning APIs
« Close Jobs API Create Datafeeds API »

Create Calendar API

This API enables you to instantiate a calendar.

Request

PUT _xpack/ml/calendars/<calendar_id>

Description

For more information, see Calendars and Scheduled Events.

Path Parameters

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

Request Body

description
(string) A description of the calendar.

Authorization

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

Examples

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": []
}
« Close Jobs API Create Datafeeds API »