This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Create anomaly detection jobs API Create datafeeds API »

› › ›

Create calendars API

edit

Create calendars API

edit

Instantiates a calendar.

Request

edit

PUT _ml/calendars/<calendar_id>

Prerequisites

edit

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

Description

edit

For 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

edit

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": []
}

« Create anomaly detection jobs API Create datafeeds API »