IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get buckets API Get categories API »
Elastic Docs ›Elasticsearch Guide [7.13] ›REST APIs ›Machine learning anomaly detection APIs

Get calendars API

edit

Get calendars API

edit

Retrieves configuration information for calendars.

Request

edit

GET _ml/calendars/<calendar_id>

GET _ml/calendars/_all

Prerequisites

edit

Requires the monitor_ml cluster privilege. This privilege is included in the machine_learning_user built-in role.

Description

edit

You can get information for multiple calendars in a single API request by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using _all, by specifying * as the <calendar_id>, or by omitting the <calendar_id>.

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
page.from
(Optional, integer) Skips the specified number of calendars. Defaults to 0.
page.size
(Optional, integer) Specifies the maximum number of calendars to obtain. Defaults to 0.

Response body

edit

The API returns an array of calendar resources, which have the following properties:

calendar_id
(string) A string that uniquely identifies a calendar.
job_ids
(array) An array of anomaly detection job identifiers. For example: ["total-requests"].

Examples

edit
GET _ml/calendars/planned-outages

The API returns the following results:

{
  "count": 1,
  "calendars": [
    {
      "calendar_id": "planned-outages",
      "job_ids": [
        "total-requests"
      ]
    }
  ]
}
« Get buckets API Get categories API »