Link Search Menu Expand Document Documentation Menu
Documentation

You're viewing version 2.17 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Refresh index

Introduced 1.0

The Refresh Index API refreshes one or more indexes in an OpenSearch cluster. In the case of data streams, the Refresh Index API refreshes a stream’s backing indexes.

OpenSearch’s refresh behavior depends on whether or not index.refresh_interval is set:

  • When set, indexes are refreshed based on the index.refresh_interval setting (in seconds). For more information about index.refresh_interval settings, see Dynamic index-level index settings.
  • When not set, refreshes occur every second until the shard receives no search requests for at least the amount of time specified by the index.search.idle.after setting (in seconds). Default is 30s.

After a shard becomes idle, the indexes will not refresh until either the next search request or a Refresh Index API request is sent. The first search request on an idle shard will wait for the refresh operation to complete.

To use the Refresh Index API, you must have write access to the indexes you want to refresh.

Path and HTTP methods

POST /_refresh
GET /_refresh
POST /<index>/_refresh
GET /<index>/_refresh

Path parameters

The following table lists the available path parameters. All path parameters are optional.

Parameter Data type Description
index String A comma-separated list of index names to be refreshed. Wildcards are accepted.

Query parameters

The following table lists the available query parameters. All query parameters are optional.

Parameter Data type Description
ignore_unavailable Boolean When false, the request returns an error when it targets a missing or closed index. Default is false.
allow_no_indices Boolean When false, the Refresh Index API returns an error when a wildcard expression, index alias, or _all targets only closed or missing indexes, even when the request is made against open indexes. Default is true.
expand_wildcards String The type of index that the wildcard patterns can match. If the request targets data streams, this argument determines whether the wildcard expressions match any hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are all, open, closed, hidden, and none.

Example requests

Refresh several data streams or indexes

The following example request refreshes two indexes named my-index-A and my-index-B:

POST /my-index-A,my-index-B/_refresh

Refresh all data streams and indexes in a cluster

The following request refreshes all data streams and indexes in a cluster:

POST /_refresh

350 characters left

Have a question? .

Want to contribute? or .