Search + K

Command Palette

Search for a command to run...

Sign In

Clear the API key cache

POST /_security/api_key/{ids}/_clear_cache
Copy endpoint

Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index.

Required authorization

  • Cluster privileges: manage_security

Parameters

path Path Parameters

Name Type
ids required

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.

type TypesIds = type TypesId = string | type TypesId = string[]

Responses

200 application/json
{ _nodes: TypesNodeStatistics

Contains statistics about the number of nodes selected by the request.

interface TypesNodeStatistics {
failures?: TypesErrorCause[];
total: number;
successful: number;
failed: number;
}
;cluster_name: TypesName
type TypesName = string
;nodes: { }; }