Get calendars API

» » »

Retrieves configuration information for calendars.

GET _ml/calendars/<calendar_id>

GET _ml/calendars/_all

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

page

The API returns the following information:

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

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

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