Clear the API key cache

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

ids union Id | [] Id 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.

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache

JavaScript Elasticsearch JavaScript Client

const response = await client.security.clearApiKeyCache({
  ids: "yVGMr3QByxdh1MSaicYx",
});

Python Elasticsearch Python Client

resp = client.security.clear_api_key_cache(
    ids="yVGMr3QByxdh1MSaicYx",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().clearApiKeyCache(c -> c
    .ids("yVGMr3QByxdh1MSaicYx")
);

C# Elasticsearch .NET Client

var response = await client.Security.ClearApiKeyCacheAsync(ids: new[] { "yVGMr3QByxdh1MSaicYx" });

PHP Elasticsearch PHP Client

$resp = $client->security()->clearApiKeyCache([
    "ids" => "yVGMr3QByxdh1MSaicYx",
]);

Ruby Elasticsearch Ruby Client

response = client.security.clear_api_key_cache(
  ids: "yVGMr3QByxdh1MSaicYx"
)

Response

No example