mirror of
https://github.com/iSharkFly-Docs/opensearch-docs-cn
synced 2025-02-10 23:34:41 +00:00
84e4ab158e
* Fix APIs File Signed-off-by: samipak458 <samipak458@gmail.com> * Update API files according to API template Signed-off-by: samipak458 <samipak458@gmail.com> * Update exec-stored-script.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update cat-aliases.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * Update cat-allocation.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * Update cat-cluster_manager.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * Update cat-count.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * Update cat-field-data.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * Update cat-health.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * updated * updated * updated --------- Signed-off-by: samipak458 <samipak458@gmail.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
---
|
|
layout: default
|
|
title: Delete Snapshot
|
|
parent: Snapshot APIs
|
|
nav_order: 7
|
|
---
|
|
|
|
## Delete snapshot
|
|
**Introduced 1.0**
|
|
{: .label .label-purple }
|
|
|
|
Deletes a snapshot from a repository.
|
|
|
|
* To learn more about snapshots, see [Snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/index).
|
|
|
|
* To view a list of your repositories, see [cat repositories]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-repositories).
|
|
|
|
* To view a list of your snapshots, see [cat snapshots]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-snapshots).
|
|
|
|
## Path parameters
|
|
|
|
Parameter | Data type | Description
|
|
:--- | :--- | :---
|
|
repository | String | Repostory that contains the snapshot. |
|
|
snapshot | String | Snapshot to delete. |
|
|
|
|
#### Example request
|
|
|
|
The following request deletes a snapshot called `my-first-snapshot` from the `my-opensearch-repo` repository:
|
|
|
|
```json
|
|
DELETE _snapshot/my-opensearch-repo/my-first-snapshot
|
|
```
|
|
{% include copy-curl.html %}
|
|
|
|
#### Example response
|
|
|
|
Upon success, the response returns the following JSON object:
|
|
|
|
```json
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
```
|
|
|
|
To verify that the snapshot was deleted, use the [Get snapshot]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot) API, passing the snapshot name as the `snapshot` path parameter.
|
|
{: .note}
|