IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get calendars API
editGet calendars API
editRetrieves configuration information for calendars.
Prerequisites
edit-
You must have
monitor_ml
,monitor
,manage_ml
, ormanage
cluster privileges to use this API. For more information, see Security privileges.
Description
editYou can get information for a single calendar or for all calendars by using
_all
.
Path parameters
edit-
calendar_id
- (Required, string) Identifier for the calendar.
Request body
edit-
page
-
-
from
- (integer) Skips the specified number of calendars.
-
size
- (integer) Specifies the maximum number of calendars to obtain.
-
Response body
editThe API returns the following information:
-
calendars
- (array) An array of calendar resources. For more information, see Calendar resources.
Examples
editThe 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" ] } ] }