Clear the API key cache Generally available; Added in 7.10.0

POST /_security/api_key/{ids}/_clear_cache
Api key auth Basic auth Bearer auth

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

Path parameters

  • ids string | array[string] 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.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • _nodes object Required

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

      Hide _nodes attributes Show _nodes attributes object
      • failures array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Hide failures attributes Show failures attributes object
        • type string Required

          The type of error

        • reason string | null

          A human-readable explanation of the error, in English.

          One of:
          string-1 string string-2 string | null
        • stack_trace string

          The server stack trace. Present only if the error_trace=true parameter was sent with the request.

        • caused_by object

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • root_cause array[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • suppressed array[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • total number Required

        Total number of nodes selected by the request.

      • successful number Required

        Number of nodes that responded successfully to the request.

      • failed number Required

        Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

    • cluster_name string Required
    • nodes object Required
      Hide nodes attribute Show nodes attribute object
      • * object Additional properties
        Hide * attribute Show * attribute object
        • name string Required
POST /_security/api_key/{ids}/_clear_cache 
POST /_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache 
resp = client.security.clear_api_key_cache( ids="yVGMr3QByxdh1MSaicYx", )
const response = await client.security.clearApiKeyCache({ ids: "yVGMr3QByxdh1MSaicYx", });
response = client.security.clear_api_key_cache( ids: "yVGMr3QByxdh1MSaicYx" )
$resp = $client->security()->clearApiKeyCache([ "ids" => "yVGMr3QByxdh1MSaicYx", ]);
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache"
client.security().clearApiKeyCache(c -> c .ids("yVGMr3QByxdh1MSaicYx") );