Registering or updating a snapshot repository

You can register a new repository in which to store snapshots or update information for an existing repository by using the snapshots API.

There are two types of snapshot repositories:

• File system (fs): For instructions on creating an fs repository, see Register repository shared file system.
• Amazon Simple Storage Service (Amazon S3) bucket (s3): For instructions on creating an s3 repository, see Register repository Amazon S3.

For instructions on creating a repository, see Register repository.

Path and HTTP methods

POST /_snapshot/my-first-repo/ 
PUT /_snapshot/my-first-repo/

Path parameters

Request parameters

Request parameters depend on the type of repository: fs or s3.

fs repository

Example request

The following example registers an fs repository using the local directory /mnt/snapshots as location.

PUT /_snapshot/my-fs-repository
{
  "type": "fs",
  "settings": {
    "location": "/mnt/snapshots"
  }
}

copy

s3 repository

For the base_path parameter, do not enter the s3:// prefix when entering your S3 bucket details. Only the name of the bucket is required.

Example request

The following request registers a new S3 repository called my-opensearch-repo in an existing bucket called my-open-search-bucket. By default, all snapshots are stored in the my/snapshot/directory.

PUT /_snapshot/my-opensearch-repo
{
  "type": "s3",
  "settings": {
    "bucket": "my-open-search-bucket",
    "base_path": "my/snapshot/directory"
  }
}

copy

Example response

Upon success, the following JSON object is returned:

{
  "acknowledged": true
}

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