Refresh APIedit

Refreshes one or more indices.

POST /twitter/_refresh

Requestedit

POST <index>/_refresh

GET <index>/_refresh

POST /_refresh

GET /_refresh

Descriptionedit

Use the refresh API to explicitly refresh one or more indices. A refresh makes all operations performed on an index since the last refresh available for search.

By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds. You can change this default interval using the index.refresh_interval setting.

Important

Refreshes are a resource-intensive. To ensure good cluster performance, we recommend waiting for Elasticsearch’s periodic refresh rather than performing an explicit refresh when possible.

If your application workflow indexes documents and then runs a search to retrieve the indexed document, we recommend using the index API's refresh=wait_for query parameter option. This option ensures the indexing operation waits for a periodic refresh before running the search.

Path parametersedit

<index>

(Optional, string) Comma-separated list or wildcard expression of index names used to limit the request.

To refresh all indices in the cluster, omit this parameter or use a value of _all or *.

Query parametersedit

allow_no_indices

(Optional, boolean) If true, the request does not return an error if a wildcard expression or _all value retrieves only missing or closed indices.

This parameter also applies to index aliases that point to a missing or closed index.

expand_wildcards

(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Valid values are:

all
Expand to open and closed indices.
open
Expand only to open indices.
closed
Expand only to closed indices.
none
Wildcard expressions are not accepted.

Defaults to open.

ignore_unavailable
(Optional, boolean) If true, missing or closed indices are not included in the response. Defaults to false.

Examplesedit

Refresh several indicesedit

POST /kimchy,elasticsearch/_refresh

Refresh all indicesedit

POST /_refresh