Get calendars API
Retrieves configuration information for calendars.
Request
GET _ml/calendars/<calendar_id>
GET _ml/calendars/_all
Prerequisites
- If the Elasticsearch security features are enabled, you must have
monitor_ml
,monitor
,manage_ml
, ormanage
cluster privileges to use this API. See Security privileges and Machine learning security privileges.
Description
You can get information for a single calendar or for all calendars by using _all
.
For more information, see Calendars and scheduled events.
Path parameters
<calendar_id>
(Required, string) A string that uniquely identifies a calendar.
Request body
page
.from
(Optional, integer) Skips the specified number of calendars.
page
.size
(Optional, integer) Specifies the maximum number of calendars to obtain.
Response body
The API returns an array of calendar resources, which have the following properties:
calendar_id
(string) A string that uniquely identifies a calendar.
job_ids
(array) An array of anomaly detection job identifiers. For example: ["total-requests"]
.
Examples
GET _ml/calendars/planned-outages
The API returns the following results:
{
"count": 1,
"calendars": [
{
"calendar_id": "planned-outages",
"job_ids": [
"total-requests"
]
}
]
}