Skip to content
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
ab80caa
Add documentation for Clone Snapshot API
Reiyadowns Sep 14, 2024
4a351b4
Light edits
Reiyadowns Sep 17, 2024
4cde4ca
Fixed title
Reiyadowns Sep 17, 2024
a01d0e0
Merge branch 'main' into add-clone-snapshot-docs
Reiyadowns Sep 24, 2024
b7d05e3
Remove unnecessary clone-repository file
Reiyadowns Sep 24, 2024
1c08e63
Merge branch 'add-clone-snapshot-docs' of https://github.com/Reiyadow…
Reiyadowns Sep 24, 2024
6ac9fa0
Merge branch 'main' into add-clone-snapshot-docs
Reiyadowns Sep 27, 2024
f157164
Merge branch 'main' into add-clone-snapshot-docs
Naarcha-AWS Oct 3, 2024
34e8360
Merge branch 'main' into add-clone-snapshot-docs
Reiyadowns Feb 6, 2025
f968ac8
Merge branch 'main' into add-clone-snapshot-docs
Naarcha-AWS Feb 14, 2025
4b3818d
Merge branch 'main' into add-clone-snapshot-docs
Reiyadowns Feb 24, 2025
24c6842
Merge branch 'main' into add-clone-snapshot-docs
Naarcha-AWS Mar 12, 2025
f319a8e
Merge branch 'main' into add-clone-snapshot-docs
Naarcha-AWS Mar 25, 2025
ddc982a
Update page with automation markers
Naarcha-AWS Mar 25, 2025
c0e724f
Remove response body.
Naarcha-AWS Mar 28, 2025
9672848
Apply suggestions from code review
Naarcha-AWS Mar 28, 2025
38b7321
Merge branch 'main' into add-clone-snapshot-docs
Naarcha-AWS Mar 28, 2025
028382a
Update clone-snapshot.md
Naarcha-AWS Mar 28, 2025
4feb956
Apply suggestions from code review
Naarcha-AWS Mar 28, 2025
513f158
Apply suggestions from code review
Naarcha-AWS Mar 28, 2025
e89a359
Apply suggestions from code review
Naarcha-AWS Mar 28, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions _api-reference/snapshots/clone-snapshot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
layout: default
title: Clone snapshot
parent: Snapshot APIs
nav_order: 10
---

# Clone snapshot
Introduced 1.0
{: .label .label-purple }

Creates a clone of all or part of a snapshot in the same repository as the original.


<!-- spec_insert_start
api: snapshot.clone
component: endpoints
-->
## Endpoints
```json
PUT /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}
```
<!-- spec_insert_end -->

<!-- spec_insert_start
api: snapshot.clone
component: path_parameters
-->
## Path parameters

The following table lists the available path parameters.

| Parameter | Required | Data type | Description |
| :--- | :--- | :--- | :--- |
| `repository` | **Required** | String | The name of repository that will contain the snapshot clone. |
| `snapshot` | **Required** | String | The name of the original snapshot. |
| `target_snapshot` | **Required** | String | The name of the cloned snapshot. |

<!-- spec_insert_end -->


<!-- spec_insert_start
api: snapshot.clone
component: query_parameters
include_deprecated: false
-->
## Query parameters

The following table lists the available query parameters. All query parameters are optional.

| Parameter | Data type | Description |
| :--- | :--- | :--- |
| `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). |

<!-- spec_insert_end -->


## Example request

The following request clones indexes `index_a` and `index_b` from `my_snapshot`, a snapshot located in the snapshot repository `my-opensearch-repo`, into a new snapshot in the same repository called `my_new_snapshot`:

```json
PUT /_snapshot/my-opensearch-repo/my_snapshot/_clone/my_new_snapshot
{
“indices” : “index_a,index_b”
}
```
{% include copy-curl.html %}


## Example response

The successful creation of a snapshot clone returns the following response:

```json
{
"acknowledged" : true
}
```

Loading