Delete Index APIedit

Delete Index Requestedit

A DeleteIndexRequest requires an index argument:

DeleteIndexRequest request = new DeleteIndexRequest("posts"); 


Optional argumentsedit

The following arguments can optionally be provided:


Timeout to wait for the all the nodes to acknowledge the index deletion as a TimeValue

Timeout to wait for the all the nodes to acknowledge the index deletion as a String


Timeout to connect to the master node as a TimeValue

Timeout to connect to the master node as a String


Setting IndicesOptions controls how unavailable indices are resolved and how wildcard expressions are expanded

Synchronous executionedit

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

AcknowledgedResponse deleteIndexResponse = client.indices().delete(request, requestOptions);

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 DeleteIndexRequest 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 delete-index method:

client.indices().deleteAsync(request, RequestOptions.DEFAULT, listener); 

The DeleteIndexRequest 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 delete-index looks like:

ActionListener<AcknowledgedResponse> listener =
        new ActionListener<AcknowledgedResponse>() {
    public void onResponse(AcknowledgedResponse deleteIndexResponse) {

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole DeleteIndexRequest fails.

Delete Index Responseedit

The returned DeleteIndexResponse allows to retrieve information about the executed operation as follows:

boolean acknowledged = deleteIndexResponse.isAcknowledged(); 

Indicates whether all of the nodes have acknowledged the request

If the index was not found, an ElasticsearchException will be thrown:

try {
    DeleteIndexRequest request = new DeleteIndexRequest("does_not_exist");
    client.indices().delete(request, RequestOptions.DEFAULT);
} catch (ElasticsearchException exception) {
    if (exception.status() == RestStatus.NOT_FOUND) {

Do something if the index to be deleted was not found