Get Calendars API

Retrieves configuration information for calendars.

Request

GET _xpack/ml/calendars/<calendar_id>

GET _xpack/ml/calendars/_all

Description

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

Path Parameters

calendar_id
(string) Identifier for the calendar.

Request Body

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

Results

The API returns the following information:

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

Authorization

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

Examples

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