elasticsearch/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc

[role="xpack"]
[testenv="platinum"]
[[ml-put-calendar]]
= Create calendars API
++++
<titleabbrev>Create calendars</titleabbrev>
++++

Instantiates a calendar.

[[ml-put-calendar-request]]
== {api-request-title}

`PUT _ml/calendars/<calendar_id>`

[[ml-put-calendar-prereqs]]
== {api-prereq-title}

Requires the `manage_ml` cluster privilege. This privilege is included in the 
`machine_learning_admin` built-in role.

[[ml-put-calendar-desc]]
== {api-description-title}

For more information, see
{ml-docs}/ml-ad-finding-anomalies.html#ml-ad-calendars[Calendars and scheduled events].

[[ml-put-calendar-path-parms]]
== {api-path-parms-title}

`<calendar_id>`::
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]

[[ml-put-calendar-request-body]]
== {api-request-body-title}

`description`::
(Optional, string) A description of the calendar.

[[ml-put-calendar-example]]
== {api-examples-title}

[source,console]
--------------------------------------------------
PUT _ml/calendars/planned-outages
--------------------------------------------------
// TEST[skip:need-license]

When the calendar is created, you receive the following results:

[source,console-result]
----
{
  "calendar_id": "planned-outages",
  "job_ids": []
}
----