IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Forecast Jobs API Get Buckets API »
Elastic Docs ›Elasticsearch Guide [6.3] ›X-Pack APIs ›Machine Learning APIs

Get Calendars API

edit

Get Calendars API

edit

Retrieves configuration information for calendars.

Request

edit

GET _xpack/ml/calendars/<calendar_id>

GET _xpack/ml/calendars/_all

Description

edit

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

Path Parameters

edit
calendar_id
(string) Identifier for the calendar.

Request Body

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

Results

edit

The API returns the following information:

calendars
(array) An array of calendar resources. For more information, see Calendar Resources.

Authorization

edit

You must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API. For more information, see Security privileges.

Examples

edit

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

GET _xpack/ml/calendars/planned-outages

The API returns the following results:

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