This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Remove policy from index API
editRemove policy from index API
editRemoves assigned lifecycle policies from an index or a data stream’s backing indices.
Request
editPOST <target>/_ilm/remove
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
manage_ilm
privileges on the indices being managed to use this API. For more information, see Security privileges.
Description
editFor indices, the remove lifecycle policy API removes the assigned lifecycle policy and stops managing the specified index.
For data streams, the API removes any assigned lifecycle policies from the stream’s backing indices and stops managing the indices.
Path parameters
edit-
<target>
-
(Required, string) Comma-separated list of data streams, indices, and aliases to
target. Supports wildcards (
*
). To target all data streams and indices, use*
or_all
.
Query parameters
edit-
master_timeout
-
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout.
Examples
editThe following example removes the assigned policy from my-index-000001
.
resp = client.ilm.remove_policy( index="my-index-000001", ) print(resp)
response = client.ilm.remove_policy( index: 'my-index-000001' ) puts response
const response = await client.ilm.removePolicy({ index: "my-index-000001", }); console.log(response);
POST my-index-000001/_ilm/remove
If the request succeeds, you receive the following result:
{ "has_failures" : false, "failed_indexes" : [] }