Create a calendar

Auth

Required privileges

calendar_id string required: A string that uniquely identifies a calendar.

application/json

calendar_id string required: A string that uniquely identifies a calendar.
description string: A description of the calendar.
job_ids union oneOf required: A list of anomaly detection job identifiers or group names.; One of: string[] or string

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

PUT _ml/calendars/planned-outages

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.ml().putCalendar(p -> p
    .calendarId("planned-outages")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.PutCalendarAsync(calendarId: "planned-outages");

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

{
  "calendar_id": "string",
  "description": "string",
  "job_ids": "string"
}

Generated from the API spec