Clone Snapshot APIedit

The Clone Snapshot API clones part or all of a snapshot into a new snapshot.


A CloneSnapshotRequest:

CloneSnapshotRequest request = new CloneSnapshotRequest(repositoryName, sourceSnapshotName, targetSnapshotName, indices);

Indices to Cloneedit

Use indices to specify a list of indices from the source snapshot to include in the snapshot clone:


Include only test_index from the source snapshot.

Index Settings and Optionsedit

You can also customize index settings and options when cloning a snapshot:

request.indicesOptions(new IndicesOptions(

Set IndicesOptions.Option.IGNORE_UNAVAILABLE in #indicesOptions() to have the clone succeed even if indices are missing in the source snapshot.

Further Argumentsedit

You can also provide the following optional arguments:


Timeout to connect to the master node as a TimeValue

Timeout to connect to the master node as a String

Synchronous Executionedit

AcknowledgedResponse response = client.snapshot().clone(request, RequestOptions.DEFAULT);

Asynchronous Executionedit

The asynchronous execution of a clone snapshot request requires both the CloneSnapshotRequest instance and an ActionListener instance to be passed to the asynchronous method:

client.snapshot().cloneAsync(request, RequestOptions.DEFAULT, listener); 

The CloneSnapshotRequest 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.

A typical listener for AcknowledgedResponse looks like:

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

        public void onFailure(Exception e) {

Called when the execution is successfully completed. The response is provided as an argument.

Called in case of a failure. The raised exception is provided as an argument.


AcknowledgedResponse indicates whether the request was received:

boolean acknowledged = response.isAcknowledged();  

A boolean value of true if the clone successfully completed. Otherwise, the value is false.