Get calendar configuration info

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

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Request body

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

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body