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

« Searchable snapshot statistics API Security APIs »

› › ›

Clear cache API

edit

Clear cache API

edit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Clears indices and data streams from the shared cache for partially mounted indices.

Request

edit

POST /_searchable_snapshots/cache/clear

POST /<target>/_searchable_snapshots/cache/clear

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the manage cluster privilege to use this API. You must also have the manage index privileges for the target data stream, index, or alias.

Path parameters

edit

<target>: (Optional, string) Comma-separated list of data streams, indices, and aliases to clear from the cache. Supports wildcards (*). To clear the entire cache, omit this parameter.

Examples

edit

Clears the cache of the index my-index:

resp = client.searchable_snapshots.clear_cache(
    index="my-index",
)
print(resp)

response = client.searchable_snapshots.clear_cache(
  index: 'my-index'
)
puts response

const response = await client.searchableSnapshots.clearCache({
  index: "my-index",
});
console.log(response);

POST /my-index/_searchable_snapshots/cache/clear

« Searchable snapshot statistics API Security APIs »