Create calendars API
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
Create calendars API
editInstantiates a calendar.
Request
editPUT _ml/calendars/<calendar_id>
Prerequisites
editRequires the manage_ml cluster privilege. This privilege is included in the
machine_learning_admin built-in role.
Description
editFor more information, see Calendars and scheduled events.
Path parameters
edit-
<calendar_id> - (Required, string) A string that uniquely identifies a calendar.
Request body
edit-
description - (Optional, string) A description of the calendar.
Examples
editresp = 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": []
}