Roll over to a new index

Auth
Tip

To automate rollovers, use index lifecycle management (ILM) in deployments that support it. Serverless does not support ILM. For data streams in Serverless, use data stream lifecycle instead.

The rollover API creates a new index for a data stream or index alias. The API behavior depends on the rollover target.

Roll over a data stream

If you roll over a data stream, the API creates a new write index for the stream. The stream's previous write index becomes a regular backing index. A rollover also increments the data stream's generation.

Roll over an index alias with a write index

Tip

Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data. Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers.

If an index alias points to multiple indices, one of the indices must be a write index. The rollover API creates a new write index for the alias with is_write_index set to true. The API also sets is_write_index to false for the previous write index.

Roll over an index alias with one index

If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.

Note

A rollover creates a new index and is subject to the wait_for_active_shards setting.

Increment index names for an alias

When you roll over an index alias, you can specify a name for the new index. If you don't specify a name and the current index ends with - and a number, such as my-index-000001 or my-index-3, the new index name increments that number. For example, if you roll over an alias with a current index of my-index-000001, the rollover creates a new index named my-index-000002. This number is always six characters and zero-padded, regardless of the previous index's name.

If you use an index alias for time series data, you can use date math in the index name to track the rollover date. For example, you can create an alias that points to an index named <my-index-{now/d}-000001>. If you create the index on May 6, 2099, the index's name is my-index-2099.05.06-000001. If you roll over the alias on May 7, 2099, the new index's name is my-index-2099.05.07-000002.

Required privileges

Index privileges manage

Path parameters

alias string required

Name of the data stream or index alias to roll over.

new_index string optional

Name of the index to create. Supports date math. Data streams do not support this parameter.

Leave it out to use /{alias}/_rollover.

Query parameters

dry_run boolean · default: false

If true, checks whether the current index satisfies the specified conditions but does not perform a rollover.

master_timeout string · default: 30s

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

timeout string · default: 30s

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

wait_for_active_shards union oneOf · default: 1

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

Values: all index-setting
lazy boolean · default: false

If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.

Request body

aliases map string to object

Aliases for the target index. Data streams do not support this parameter.

settings map string to object

Configuration options for the index. Data streams do not support this parameter.

Response

application/json
acknowledged boolean required
conditions map string to boolean required
dry_run boolean required
new_index string required
old_index string required
rolled_over boolean required
shards_acknowledged boolean required