Create a calendar | Elasticsearch API documentation

Create a calendar Generally available; Added in 6.2.0

PUT /_ml/calendars/{calendar_id}

Api key auth Basic auth Bearer auth

Required authorization

Cluster privileges: manage_ml

Path parameters

calendar_id string Required

A string that uniquely identifies a calendar.

application/json

Body

job_ids array[string]

An array of anomaly detection job identifiers.
description string

A description of the calendar.

Responses

200 application/json
Hide response attributes Show response attributes object
- calendar_id string Required
- description string
  
  A description of the calendar.
- job_ids string | array[string] Required
  
  One of:
  Id string Ids array[string]

PUT /_ml/calendars/{calendar_id}

PUT _ml/calendars/planned-outages

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

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

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

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

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