Clone a snapshot

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

Api key auth Basic auth Bearer auth

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

Required authorization

Cluster privileges: manage

Path Parameters

Query Parameters

master_timeout string Duration · 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.

Request

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

Response

application/json

Examples

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

Request Console 1 / 8 languages

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

No example

Required authorization

Path Parameters { repository , snapshot , target_snapshot , }

Query Parameters

Request

Response

Path Parameters