Link Search Menu Expand Document Documentation Menu

Delete snapshot repository configuration

Introduced 1.0

Deletes a snapshot repository configuration.

A repository in OpenSearch is simply a configuration that maps a repository name to a type (file system or s3 repository) along with other information depending on the type. The configuration is backed by a file system location or an s3 bucket. When you invoke the API, the physical file system or s3 bucket itself is not deleted. Only the configuration is deleted.

To learn more about repositories, see Register or update snapshot repository.

Path parameters

Parameter Data type Description
repository String Repository to delete.

Example request

The following request deletes the my-opensearch-repo repository:

DELETE _snapshot/my-opensearch-repo

Example response

Upon success, the response returns the following JSON object:

  "acknowledged" : true

To verify that the repository was deleted, use the Get snapshot repository API, passing the repository name as the repository path parameter.

350 characters left

Have a question? .

Want to contribute? or .