NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Get calendars API
editGet calendars API
editRetrieves configuration information for calendars.
Request
editGET _xpack/ml/calendars/<calendar_id>
GET _xpack/ml/calendars/_all
Description
editYou can get information for a single calendar or for all calendars by using
_all
.
Path Parameters
edit-
calendar_id
- (string) Identifier for the calendar.
Query Parameters
edit-
from
-
(Optional, integer) Skips the specified number of calendars. This parameter
is supported only when you omit the
<calendar_id>
. Defaults to0
. -
size
-
(Optional, integer) Specifies the maximum number of calendars to obtain.
This parameter is supported only when you omit the
<calendar_id>
. Defaults to100
.
Request Body
edit-
page.from
-
(integer) Skips the specified number of calendars. This object is
supported only when you omit the
<calendar_id>
. Defaults to0
. -
page.size
-
(integer) Specifies the maximum number of calendars to obtain. This object
is supported only when you omit the
<calendar_id>
. Defaults to100
.
Results
editThe API returns the following information:
-
calendars
- (array) An array of calendar resources. For more information, see Calendar resources.
Authorization
editYou must have monitor_ml
, monitor
, manage_ml
, or manage
cluster
privileges to use this API. For more information, see
Security privileges.
Examples
editThe 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" ] } ] }