OpenSearch/docs/reference/ml/apis/put-calendar.asciidoc

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

Instantiates a calendar.

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

`PUT _ml/calendars/<calendar_id>`

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

* If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges].

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

For more information, see
{stack-ov}/ml-calendars.html[Calendars and Scheduled Events].

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

`<calendar_id>` (Required)::
  (string) Identifier for the calendar.

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

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

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

The following example creates the `planned-outages` calendar:

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

When the calendar is created, you receive the following results:
[source,js]
----
{
  "calendar_id": "planned-outages",
  "job_ids": []
}
----
// TESTRESPONSE