Query API Key information APIedit

API Key(s) information can be queried and retrieved in a paginated fashion using this API.

Query API Key Requestedit

The QueryApiKeyRequest supports query and retrieving API key information using Elasticsearch’s Query DSL with pagination. It supports only a subset of available query types, including:

Query for all API keysedit

In its most basic form, the request selects all API keys that the user has access to.

QueryApiKeyRequest queryApiKeyRequest = new QueryApiKeyRequest();

Query API keys with Query DSLedit

The following query selects API keys owned by the user and also satisfy following criteria: * The API key name must begin with the word key * The API key name must not be key-20000

QueryApiKeyRequest queryApiKeyRequest = new QueryApiKeyRequest().queryBuilder(
        .must(QueryBuilders.prefixQuery("metadata.environment", "east-"))
        .mustNot(QueryBuilders.termQuery("name", "key-20000")));

Retrieve API keys with explicitly configured sort and pagingedit

The following request sort the API keys by their names in descending order. It also retrieves the API keys from index 1 (zero-based) and in a page size of 100.

QueryApiKeyRequest queryApiKeyRequest = new QueryApiKeyRequest()
    .fieldSortBuilders(org.elasticsearch.core.List.of(new FieldSortBuilder("name").order(SortOrder.DESC)));

Deep pagination can be achieved with search afteredit

QueryApiKeyRequest queryApiKeyRequest = new QueryApiKeyRequest()
    .fieldSortBuilders(org.elasticsearch.core.List.of(new FieldSortBuilder("name")))
    .searchAfterBuilder(new SearchAfterBuilder().setSortValues(new String[] {"key-10000"}));

Synchronous executionedit

When executing a QueryApiKeyRequest in the following manner, the client waits for the QueryApiKeyResponse to be returned before continuing with code execution:

QueryApiKeyResponse queryApiKeyResponse = client.security().queryApiKey(queryApiKeyRequest, RequestOptions.DEFAULT);

Synchronous calls may throw an IOException in case of either failing to parse the REST response in the high-level REST client, the request times out or similar cases where there is no response coming back from the server.

In cases where the server returns a 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous executionedit

Executing a QueryApiKeyRequest can also be done in an asynchronous fashion so that the client can return directly. Users need to specify how the response or potential failures will be handled by passing the request and a listener to the asynchronous query-api-key method:

client.security().queryApiKeyAsync(queryApiKeyRequest, RequestOptions.DEFAULT, listener); 

The QueryApiKeyRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for query-api-key looks like:

listener = new ActionListener<QueryApiKeyResponse>() {
    public void onResponse(QueryApiKeyResponse queryApiKeyResponse) {

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole QueryApiKeyRequest fails.

Query API Key information API Responseedit

The returned QueryApiKeyResponse contains the information regarding the API keys that were requested.

final long total = queryApiKeyResponse.getTotal();  
final int count = queryApiKeyResponse.getCount();  
final List<ApiKey> apiKeys = queryApiKeyResponse.getApiKeys();  
final Object[] sortValues = apiKeys.get(apiKeys.size()-1).getSortValues();  

Total number of API keys matched by the query

Number of API keys returned in this response

The list of API keys

If sorting is requested, each API key in the response contains its sort values.