IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Move to lifecycle step API Retry policy execution API »

› › ›

Remove policy from index API

edit

Remove policy from index API

edit

Removes assigned lifecycle policies from an index or a data stream’s backing indices.

Request

edit

POST <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

edit

For 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.
timeout: (Optional, time units) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Examples

edit

The following example removes the assigned policy from my-index-000001.

response = client.ilm.remove_policy(
  index: 'my-index-000001'
)
puts response

POST my-index-000001/_ilm/remove

If the request succeeds, you receive the following result:

{
  "has_failures" : false,
  "failed_indexes" : []
}

« Move to lifecycle step API Retry policy execution API »