[DOCS] Add data streams to remove lifecycle policy API (#58777) (#58921)

This commit is contained in:
James Rodewig 2020-07-02 09:58:54 -04:00 committed by GitHub
parent 04ff24ca8e
commit 9569375ae7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 7 deletions

View File

@ -6,12 +6,13 @@
<titleabbrev>Remove policy</titleabbrev> <titleabbrev>Remove policy</titleabbrev>
++++ ++++
Removes the assigned lifecycle policy from an index. Removes assigned lifecycle policies from an index or a data stream's backing
indices.
[[ilm-remove-policy-request]] [[ilm-remove-policy-request]]
==== {api-request-title} ==== {api-request-title}
`POST <index>/_ilm/remove` `POST <target>/_ilm/remove`
[[ilm-remove-policy-prereqs]] [[ilm-remove-policy-prereqs]]
==== {api-prereq-title} ==== {api-prereq-title}
@ -23,15 +24,21 @@ see <<security-privileges>>.
[[ilm-remove-policy-desc]] [[ilm-remove-policy-desc]]
==== {api-description-title} ==== {api-description-title}
Removes the assigned lifecycle policy and stops managing the specified index. For indices, the remove lifecycle policy API removes the assigned lifecycle
If an index pattern is specified, removes the assigned policies from all matching policy and stops managing the specified index.
indices.
For data streams, the API removes any assigned lifecycle policies from
the stream's backing indices and stops managing the indices.
[[ilm-remove-policy-path-params]] [[ilm-remove-policy-path-params]]
==== {api-path-parms-title} ==== {api-path-parms-title}
`<index>`:: `<target>`::
(Required, string) Identifier for the index. (Required, string)
Comma-separated list of data streams, indices, and index aliases to target.
Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, use `_all` or `*`.
[[ilm-remove-policy-query-params]] [[ilm-remove-policy-query-params]]
==== {api-query-parms-title} ==== {api-query-parms-title}