OpenSearch/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc

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

Deletes a calendar.

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

`DELETE _ml/calendars/<calendar_id>`

[[ml-delete-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-delete-calendar-desc]]
==== {api-description-title}

This API removes all scheduled events from the calendar then deletes the
calendar.

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

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

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

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

[source,js]
--------------------------------------------------
DELETE _ml/calendars/planned-outages
--------------------------------------------------
// CONSOLE
// TEST[skip:setup:calendar_outages]

When the calendar is deleted, you receive the following results:
[source,js]
----
{
  "acknowledged": true
}
----
// TESTRESPONSE