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

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

Deletes a calendar.


==== Request

`DELETE _xpack/ml/calendars/<calendar_id>`


==== Description

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


==== Path Parameters

`calendar_id` (required)::
  (string) Identifier for the calendar.


==== Authorization

You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see {xpack-ref}/security-privileges.html[Security Privileges].


==== Examples

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

[source,js]
--------------------------------------------------
DELETE _xpack/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