Clear the API key cache

POST /_security/api_key/{ids}/_clear_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

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

Response

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