Clone a snapshot

PUT /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}

Auth

Clone part of all of a snapshot into another snapshot in the same repository.

Required privileges

Cluster privileges manage

Path parameters

repository string required: The name of the snapshot repository that both source and target snapshot belong to.
snapshot string required: The source snapshot name.
target_snapshot string required: The target snapshot name.

Query parameters

master_timeout union oneOf · default: 30s: The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.; Values: -1 0

Request body

indices string required: A comma-separated list of indices to include in the snapshot. Multi-target syntax is supported.

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 8 languages

Run PUT /_snapshot/my_repository/source_snapshot/_clone/target_snapshot to clone the source_snapshot into a new target_snapshot.

Console Kibana Dev Tools

PUT /_snapshot/my_repository/source_snapshot/_clone/target_snapshot
{
  "indices": "index_a,index_b"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.snapshot.clone({
  repository: "my_repository",
  snapshot: "source_snapshot",
  target_snapshot: "target_snapshot",
  indices: "index_a,index_b",
});

Python Elasticsearch Python Client

resp = client.snapshot.clone(
    repository="my_repository",
    snapshot="source_snapshot",
    target_snapshot="target_snapshot",
    indices="index_a,index_b",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_snapshot/my_repository/source_snapshot/_clone/target_snapshot" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "indices": "index_a,index_b"
  }'

Java Elasticsearch Java Client

client.snapshot().clone(c -> c
    .indices("index_a,index_b")
    .repository("my_repository")
    .snapshot("source_snapshot")
    .targetSnapshot("target_snapshot")
);

C# Elasticsearch .NET Client

var response = await client.Snapshot
    .CloneAsync(repository: "my_repository", snapshot: "source_snapshot", targetSnapshot: "target_snapshot", d1 => d1
        .Indices("index_a,index_b")
    );

PHP Elasticsearch PHP Client

$resp = $client->snapshot()->clone([
    "repository" => "my_repository",
    "snapshot" => "source_snapshot",
    "target_snapshot" => "target_snapshot",
    "body" => [
        "indices" => "index_a,index_b",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.snapshot.clone(
  repository: "my_repository",
  snapshot: "source_snapshot",
  target_snapshot: "target_snapshot",
  body: {
    "indices": "index_a,index_b"
  }
)

Response

{
  "acknowledged": false
}

Generated from the API spec