Get calendars APIedit

Retrieves configuration information for calendars.

Requestedit

GET _xpack/ml/calendars/<calendar_id>

GET _xpack/ml/calendars/_all

Descriptionedit

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

Path Parametersedit

calendar_id
(string) Identifier for the calendar.

Query Parametersedit

from
(Optional, integer) Skips the specified number of calendars. This parameter is supported only when you omit the <calendar_id>. Defaults to 0.
size
(Optional, integer) Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the <calendar_id>. Defaults to 100.

Request Bodyedit

page.from
(integer) Skips the specified number of calendars. This object is supported only when you omit the <calendar_id>. Defaults to 0.
page.size
(integer) Specifies the maximum number of calendars to obtain. This object is supported only when you omit the <calendar_id>. Defaults to 100.

Resultsedit

The API returns the following information:

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

Authorizationedit

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

Examplesedit

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