Get calendar configuration info

POST also GET /_ml/calendars/{calendar_id}
POST also GET /_ml/calendars

A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using _all or * or by omitting the calendar identifier.

Leave it out to use /_ml/calendars.

Query Parameters

Request

page {} Page: This object is supported only when you omit the calendar identifier.

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ml/calendars/planned-outages

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.getCalendars({
  calendar_id: "planned-outages",
});

Python Elasticsearch Python Client

resp = client.ml.get_calendars(
    calendar_id="planned-outages",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/calendars/planned-outages" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().getCalendars(g -> g
    .calendarId("planned-outages")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .GetCalendarsAsync(d1 => d1
        .CalendarId("planned-outages")
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->getCalendars([
    "calendar_id" => "planned-outages",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.get_calendars(
  calendar_id: "planned-outages"
)

Response

No example

Get calendar configuration info

Required authorization

Path Parameters

Query Parameters

Request

Response

Required authorization

Path Parameters

Query Parameters { from , size , }

Request

Response

Query Parameters