2017-12-21 05:52:58 +08:00
|
|
|
[role="xpack"]
|
2018-09-01 07:49:24 +08:00
|
|
|
[testenv="platinum"]
|
2017-12-21 05:52:58 +08:00
|
|
|
[[ml-delete-calendar]]
|
2018-12-21 02:23:28 +08:00
|
|
|
=== Delete calendar API
|
2017-12-21 08:37:19 +08:00
|
|
|
++++
|
2018-12-21 02:23:28 +08:00
|
|
|
<titleabbrev>Delete calendar</titleabbrev>
|
2017-12-21 08:37:19 +08:00
|
|
|
++++
|
2017-12-21 05:52:58 +08:00
|
|
|
|
2018-06-14 04:37:35 +08:00
|
|
|
Deletes a calendar.
|
2017-12-21 05:52:58 +08:00
|
|
|
|
2019-06-28 00:42:47 +08:00
|
|
|
[[ml-delete-calendar-request]]
|
|
|
|
|
==== {api-request-title}
|
2017-12-21 05:52:58 +08:00
|
|
|
|
2018-12-08 04:34:11 +08:00
|
|
|
`DELETE _ml/calendars/<calendar_id>`
|
2017-12-21 05:52:58 +08:00
|
|
|
|
2019-06-28 04:58:42 +08:00
|
|
|
[[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
|
2019-10-05 07:10:26 +08:00
|
|
|
<<security-privileges>>.
|
2019-06-28 04:58:42 +08:00
|
|
|
|
2019-06-28 00:42:47 +08:00
|
|
|
[[ml-delete-calendar-desc]]
|
|
|
|
|
==== {api-description-title}
|
2018-01-25 00:14:23 +08:00
|
|
|
|
|
|
|
|
This API removes all scheduled events from the calendar then deletes the
|
|
|
|
|
calendar.
|
|
|
|
|
|
2019-06-28 00:42:47 +08:00
|
|
|
[[ml-delete-calendar-path-parms]]
|
|
|
|
|
==== {api-path-parms-title}
|
2017-12-21 05:52:58 +08:00
|
|
|
|
2019-07-12 23:26:31 +08:00
|
|
|
`<calendar_id>`::
|
2020-01-03 02:59:54 +08:00
|
|
|
(Required, string)
|
2020-06-02 02:46:10 +08:00
|
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
|
2017-12-21 05:52:58 +08:00
|
|
|
|
2019-06-28 00:42:47 +08:00
|
|
|
[[ml-delete-calendar-example]]
|
|
|
|
|
==== {api-examples-title}
|
2018-01-25 00:14:23 +08:00
|
|
|
|
2019-09-06 22:55:16 +08:00
|
|
|
[source,console]
|
2018-01-25 00:14:23 +08:00
|
|
|
--------------------------------------------------
|
2018-12-08 04:34:11 +08:00
|
|
|
DELETE _ml/calendars/planned-outages
|
2018-01-25 00:14:23 +08:00
|
|
|
--------------------------------------------------
|
2018-09-01 07:49:24 +08:00
|
|
|
// TEST[skip:setup:calendar_outages]
|
2018-01-25 00:14:23 +08:00
|
|
|
|
|
|
|
|
When the calendar is deleted, you receive the following results:
|
2019-09-06 04:47:18 +08:00
|
|
|
|
|
|
|
|
[source,console-result]
|
2018-01-25 00:14:23 +08:00
|
|
|
----
|
|
|
|
|
{
|
|
|
|
|
"acknowledged": true
|
|
|
|
|
}
|
|
|
|
|
----
|
