You're viewing version 2.12 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
Delete snapshot
Introduced 1.0
Deletes a snapshot from a repository.
-
To learn more about snapshots, see Snapshots.
-
To view a list of your repositories, see cat repositories.
-
To view a list of your snapshots, see 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:
DELETE _snapshot/my-opensearch-repo/my-first-snapshot
Example response
Upon success, the response returns the following JSON object:
{
"acknowledged": true
}
To verify that the snapshot was deleted, use the Get snapshot API, passing the snapshot name as the snapshot
path parameter.