Create API Key APIedit

API Key can be created using this API.

Create API Key Requestedit

A CreateApiKeyRequest contains an optional name for the API key, an optional list of role descriptors to define permissions and optional expiration for the generated API key. If expiration is not provided then by default the API keys do not expire.

CreateApiKeyRequest createApiKeyRequest = new CreateApiKeyRequest(name, roles, expiration, refreshPolicy, metadata);

Synchronous executionedit

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

CreateApiKeyResponse createApiKeyResponse =, 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 CreateApiKeyRequest 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 create-api-key method:, RequestOptions.DEFAULT, listener); 

The CreateApiKeyRequest 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 create-api-key looks like:

listener = new ActionListener<CreateApiKeyResponse>() {
    public void onResponse(CreateApiKeyResponse createApiKeyResponse) {

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole CreateApiKeyRequest fails.

Create API Key Responseedit

The returned CreateApiKeyResponse contains an id, API key, name for the API key and optional expiration.

SecureString encoded = createApiKeyResponse.getEncoded(); 
Instant apiKeyExpiration = createApiKeyResponse.getExpiration(); 

the API key credentials that can be used to authenticate to Elasticsearch.

expiration if the API keys expire