› › ›

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

resp = client.ml.put_calendar(
    calendar_id="planned-outages",
)
print(resp)

response = client.ml.put_calendar(
  calendar_id: 'planned-outages'
)
puts response

const response = await client.ml.putCalendar({
  calendar_id: "planned-outages",
});
console.log(response);

PUT _ml/calendars/planned-outages

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

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

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-calendar.html