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 APIedit
Retrieves configuration information for calendars.
Prerequisitesedit
-
You must have
monitor_ml,monitor,manage_ml, ormanagecluster privileges to use this API. For more information, see Security privileges.
Descriptionedit
You can get information for a single calendar or for all calendars by using
_all.
Path parametersedit
-
calendar_id - (Required, string) Identifier for the calendar.
Request bodyedit
-
page -
-
from - (integer) Skips the specified number of calendars.
-
size - (integer) Specifies the maximum number of calendars to obtain.
-
Response bodyedit
The API returns the following information:
-
calendars - (array) An array of calendar resources. For more information, see Calendar resources.
Examplesedit
The 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"
]
}
]
}