Clear the cache

POST /{index}/_cache/clear
POST /_cache/clear

Clear the cache of one or more indices. For data streams, the API clears the caches of the stream's backing indices.

By default, the clear cache API clears all caches. To clear only specific caches, use the fielddata, query, or request parameters. To clear the cache only of specific fields, use the fields parameter.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

index union oneOf

Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

One of: string[] or string

allow_no_indices boolean · default: true

A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

expand_wildcards string · default: open

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

Supported values include:

all: Match any data stream or index, including hidden ones.
open: Match open, non-hidden indices. Also matches any non-hidden data stream.
closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Values: all open closed hidden none

fielddata boolean

If true, clears the fields cache. Use the fields parameter to clear the cache of specific fields only.

fields union oneOf

Comma-separated list of field names used to limit the fielddata parameter.

One of: string[] or string

ignore_unavailable boolean · default: false

If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

query boolean

If true, clears the query cache.

request boolean

If true, clears the request cache.

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /my-index-000001,my-index-000002/_cache/clear?request=true

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.clearCache({
  index: "my-index-000001,my-index-000002",
  request: "true",
});

Python Elasticsearch Python Client

resp = client.indices.clear_cache(
    index="my-index-000001,my-index-000002",
    request=True,
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001,my-index-000002/_cache/clear?request=true" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().clearCache(c -> c
    .index(List.of("my-index-000001","my-index-000002"))
    .request(true)
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .ClearCacheAsync(d1 => d1
        .Indices(new[] { "my-index-000001", "my-index-000002" })
        .Request(true)
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->clearCache([
    "index" => "my-index-000001,my-index-000002",
    "request" => "true",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.clear_cache(
  index: "my-index-000001,my-index-000002",
  request: "true"
)

Response

No example