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

› › ›

Clear cache API

edit

Clear cache API

edit

Clears caches for one or more indices.

POST /my-index-000001/_cache/clear

Request

edit

POST /<index>/_cache/clear

POST /_cache/clear

Path parameters

edit

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

Query parameters

edit

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.

Defaults to true.

expand_wildcards

(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Multiple values are accepted when separated by a comma, as in open,hidden. Valid values are:

all: Expand to open and closed indices, including hidden indices.
open: Expand only to open indices.
closed: Expand only to closed indices.
hidden: Expansion of wildcards will include hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Defaults to open.

fielddata

(Optional, boolean) If true, clears the fields cache.

Use the fields parameter to clear the cache of specific fields only.

fields

(Optional, string) Comma-separated list of field names used to limit the fielddata parameter.

Defaults to all fields.

This parameter does not support objects or field aliases.

index

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

ignore_unavailable

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

query

(Optional, boolean) If true, clears the query cache.

request

(Optional, boolean) If true, clears the request cache.

Examples

edit

Clear a specific cache

edit

By default, the clear cache API clears all caches. You can clear only specific caches by setting the following query parameters to true:

fielddata
query
request

POST /my-index-000001/_cache/clear?fielddata=true  
POST /my-index-000001/_cache/clear?query=true      
POST /my-index-000001/_cache/clear?request=true

	Clears only the fields cache
	Clears only the query cache
	Clears only the request cache

Clear the cache of specific fields

edit

To only clear the cache of specific fields, use the fields query parameter.

POST /my-index-000001/_cache/clear?fields=foo,bar

Clear the cache for the foo and bar field

Clear caches for several indices

edit

POST /my-index-000001,my-index-000002/_cache/clear

Clear caches for all indices

edit

POST /_cache/clear

« Analyze API Clone index API »