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.3] ›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
  • If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API. See Security privileges.

Description

edit

You can get information for a single calendar or for all calendars by using _all.

For more information, see Calendars and scheduled events.

Path parameters

edit
<calendar_id>
(Required, string) Identifier for the calendar.

Request body

edit
page
from
(Optional, integer) Skips the specified number of calendars.
size
(Optional, integer) Specifies the maximum number of calendars to obtain.

Response body

edit

The API returns the following information:

calendars

(array) An array of calendar resources. A calendar resource has the following properties:

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

Examples

edit

The following example gets configuration information for the planned-outages calendar:

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 »