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:

QueryApiKeyRequest queryApiKeyRequest = new QueryApiKeyRequest();

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

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

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

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.

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 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>() {
    @Override
    public void onResponse(QueryApiKeyResponse queryApiKeyResponse) {
        
    }

    @Override
    public void onFailure(Exception e) {
        
    }
};

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();