mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-29 09:54:06 -04:00
c1019d4c5d
* (Doc+) Link API to parent Doc part1 --------- Co-authored-by: shainaraskas <shaina.raskas@elastic.co> Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
88 lines
2 KiB
Text
88 lines
2 KiB
Text
[role="xpack"]
|
|
[[ilm-delete-lifecycle]]
|
|
=== Delete lifecycle policy API
|
|
++++
|
|
<titleabbrev>Delete policy</titleabbrev>
|
|
++++
|
|
|
|
Deletes an index <<index-lifecycle-management,lifecycle>> policy.
|
|
|
|
[[ilm-delete-lifecycle-request]]
|
|
==== {api-request-title}
|
|
|
|
`DELETE _ilm/policy/<policy_id>`
|
|
|
|
[[ilm-delete-lifecycle-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `manage_ilm`
|
|
cluster privilege to use this API. For more information, see
|
|
<<security-privileges>>.
|
|
|
|
[[ilm-delete-lifecycle-desc]]
|
|
==== {api-description-title}
|
|
|
|
Deletes the specified lifecycle policy definition. You cannot delete policies
|
|
that are currently in use. If the policy is being used to manage any indices,
|
|
the request fails and returns an error.
|
|
|
|
[[ilm-delete-lifecycle-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<policy_id>`::
|
|
(Required, string) Identifier for the policy.
|
|
|
|
[[ilm-delete-lifecycle-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
|
|
|
[[ilm-delete-lifecycle-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example deletes `my_policy`:
|
|
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _ilm/policy/my_policy
|
|
{
|
|
"policy": {
|
|
"phases": {
|
|
"warm": {
|
|
"min_age": "10d",
|
|
"actions": {
|
|
"forcemerge": {
|
|
"max_num_segments": 1
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"min_age": "30d",
|
|
"actions": {
|
|
"delete": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// TEST
|
|
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE _ilm/policy/my_policy
|
|
--------------------------------------------------
|
|
// TEST[continued]
|
|
|
|
When the policy is successfully deleted, you receive the following result:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
--------------------------------------------------
|