IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Clear API key cache API
editClear API key cache API
editEvicts a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index.
Request
editPOST /_security/api_key/<ids>/_clear_cache
Prerequisites
edit-
To use this API, you must have at least the
manage_securitycluster privilege.
Description
editFor more information about API keys, see Create API keys, Get API key information, and Invalidate API key.
Path parameters
edit-
<ids> -
(Required, string)
Comma-separated list of API key IDs to evict from the API key cache. To evict
all API keys, use
*. Does not support other wildcard patterns.
Examples
editThe clear API key cache API evicts entries from the API key cache.
For example, to clear the entry of API key with ID yVGMr3QByxdh1MSaicYx.
POST /_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache
Specify multiple API keys as a comma-separated list.
POST /_security/api_key/yVGMr3QByxdh1MSaicYx,YoiMaqREw0YVpjn40iMg/_clear_cache
To clear all entries from the API key cache, use *.
POST /_security/api_key/*/_clear_cache