Skip to main content

Create and manage snapshots in Aiven for OpenSearch®

Create, list, retrieve, or delete snapshots in your Aiven for OpenSearch custom repositories.

Prerequisites​

  • Running Aiven for OpenSearch service
  • Access to the Aiven Console
  • Access to a supported object storage service (AWS S3, GCS, or Azure)
  • Credentials for the selected storage provider
  • Configured custom repository
important

Automatic snapshot scheduling is not supported. Create, list, and delete snapshots manually.

Limitations​

Supported storage services are:

  • Amazon S3
  • Google Cloud Storage (GCS)
  • Microsoft Azure Blob Storage

Create a snapshot​

Create a snapshot in a custom repository.

  1. Log in to the Aiven Console, go to your project, and open your service's page.
  2. Click Snapshots in the sidebar.
  3. On the Snapshots page, do one of the following:
    • Click Create snapshot.
    • Find your custom repository and click Actions > Create snapshot.
  4. In the Create snapshot window:
    1. Select a destination repository.
    2. Enter a snapshot name.
    3. Specify which indices to include.
    4. Optionally, enable the following:
      • Ignore unavailable indices
      • Include global state
      • Partial snapshot
    5. Click Create.

Your snapshot is being created. Monitor its status until it shows Success.

Restore from snapshots​

important

Refrain from actions such as updating firewalls, changing index settings, or modifying security configurations during the restore process as it can cause restore failures.

curl -s -X POST \
"https://api.aiven.io/v1/project/{project_name}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name}/_restore" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "indices": "test-index-*",
  "include_aliases": true,
  "ignore_unavailable": false,
  "rename_pattern": "index_(.+)",
  "rename_replacement": "restored_index_$1"
}'

Example response:

{
  "accepted": true
}

List snapshots in progress​

Preview snapshots that are still being created in a repository.

  1. Log in to the Aiven Console, go to your project, and open your service's page.
  2. Click Snapshots in the sidebar.
  3. On the Snapshots page, find your custom repository and click to expand the list of snapshots inside.
  4. In the column with snapshot status information, find in progress values.

List snapshots in a repository​

Preview all snapshots, including completed and failed ones.

  1. Log in to the Aiven Console, go to your project, and open your service's page.
  2. Click Snapshots in the sidebar.
  3. On the Snapshots page, find your custom repository and click to expand the list of snapshots inside.

View snapshot details​

Get details of a specific snapshot.

  1. Log in to the Aiven Console, go to your project, and open your service's page.
  2. Click Snapshots in the sidebar.
  3. On the Snapshots page, find your custom repository, click to expand the list of snapshots inside, find a snapshot to be previewed, and click Actions > View snapshot details.

Delete a snapshot​

Delete a snapshot from a repository.

  1. Log in to the Aiven Console, go to your project, and open your service's page.
  2. Click Snapshots in the sidebar.
  3. On the Snapshots page, find your custom repository, click to expand the list of snapshots inside, find a snapshot to be deleted, click Actions > Delete snapshot > Delete.

Error handling​

The Aiven API returns OpenSearch errors as they are.

Exceptions:

  • 502: OpenSearch did not respond.
  • 409: The service is not powered on or does not support this feature.

Related pages

OpenSearch snapshot API reference