Clear cache API
editClear cache API
editClears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing indices.
POST /my-index-000001/_cache/clear
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
manage
index privilege for the target data stream, index, or index alias.
Path parameters
edit-
<target>
-
(Optional, string) Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (
*
) are supported.To target all data streams and indices in a cluster, omit this parameter or use
_all
or*
.
Query parameters
edit-
allow_no_indices
-
(Optional, Boolean) If
false
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.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
false
, the request returns an error if it targets a missing or closed index. Defaults tofalse
. -
query
-
(Optional, Boolean)
If
true
, clears the query cache. -
request
-
(Optional, Boolean)
If
true
, clears the request cache.
Examples
editClear a specific cache
editBy 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
Clear the cache of specific fields
editTo only clear the cache of specific fields,
use the fields
query parameter.
Clear caches for several data streams and indices
editPOST /my-index-000001,my-index-000002/_cache/clear
Clear caches for all data streams and indices
editPOST /_cache/clear