Create and manage snapshots in Aiven for OpenSearch® Limited availability

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

Prerequisites

Aiven Console

• Custom repositories enabled as a limited availability feature
• 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

OpenSearch API

• Custom repositories enabled as a limited availability feature
• Maintenance updates applied for your service
• Security management enabled for your service
• Snapshot permissions and snapshot repository permissions configured

Aiven API

• Custom repositories enabled as a limited availability feature
• Running Aiven for OpenSearch service
• Aiven API and authentication token
• 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. You must create, list, and delete snapshots manually.

Limitations

Aiven Console

• Supported storage services are:
  • Amazon S3
  • Google Cloud Storage (GCS)
  • Microsoft Azure Blob Storage
• Restoring from snapshots is not supported in the Aiven Console.

OpenSearch API

• Supported storage services are:
  • Amazon S3
  • Google Cloud Storage (GCS)
  • Microsoft Azure Blob Storage
• The following operations are not supported via native OpenSearch API:
  • List snapshots in progress
  • List snapshots in a repository
• Restore from snapshot has a couple of security-related restrictions.
• Create a snapshot and delete a snapshot are not supported for snapshots in Aiven-managed repositories (prefixed with aiven_repo).

Aiven API

• Supported storage services are:
  • Amazon S3
  • Google Cloud Storage (GCS)
  • Microsoft Azure Blob Storage
• Restoring from snapshots is not supported in the Aiven API.

Create a snapshot

Create a snapshot in a custom repository.

Aiven Console

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.

OpenSearch API

Use the Create Snapshot native OpenSearch API endpoint.

Aiven API

curl -s -X POST \
--url "https://api.aiven.io/v1/project/{project_name}/service/{service_name}/opensearch/_snapshot/aws-repo/first-snapshot" \
--header "Authorization: Bearer $TOKEN" \
--header "Content-Type: application/json" \
-d '{"indices": "test*", "include_global_state": false}'

Example response:

{
  "accepted": true
}

Restore from snapshots

To restore data from a snapshot, use the Restore Snapshot native OpenSearch API endpoint.

List snapshots in progress

Preview snapshots that are still being created in a repository.

Aiven Console

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.

Aiven API

curl -s --url "https://api.aiven.io/v1/project/{project_name}/service/{service_name}/opensearch/_snapshot/aws-repo/_status" \
--header "Authorization: Bearer $TOKEN"
--header "Content-Type: application/json"

Example response:

{
  "snapshots": [
    {
      "repository": "aws-repo",
      "snapshot": "second-snapshot",
      "state": "SUCCESS",
      "shards_stats": {
        "done": 1,
        "failed": 0,
        "total": 1
      },
      "uuid": "osmCbdF-RMyyUKpWD-4bJA"
    }
  ]
}

List snapshots in a repository

Preview all snapshots, including completed and failed ones.

Aiven Console

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.

Aiven API

curl -s --url "https://api.aiven.io/v1/project/{project_name}/service/{service_name}/opensearch/_snapshot/aws-repo/_all" \
--header "Authorization: Bearer $TOKEN"
--header "Content-Type: application/json"

Example response:

{
  "snapshots": [
    {
      "snapshot": "first-snapshot",
      "state": "SUCCESS",
      "indices": ["test"],
      "uuid": "7cdWedW7RC6FMSktlZTCDw"
    },
    {
      "snapshot": "second-snapshot",
      "state": "SUCCESS",
      "indices": ["test"],
      "uuid": "osmCbdF-RMyyUKpWD-4bJA"
    }
  ]
}

View snapshot details

Get details of a specific snapshot.

Aiven Console

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.

OpenSearch API

Use the native OpenSearch API endpoints: Get Snapshot or Get Snapshot Status.

Aiven API

curl -s --url "https://api.aiven.io/v1/project/{project_name}/service/{service_name}/opensearch/_snapshot/aws-repo/first-snapshot" \
--header "Authorization: Bearer $TOKEN"
--header "Content-Type: application/json"

Example response:

{
  "snapshots": [
    {
      "snapshot": "first-snapshot",
      "state": "SUCCESS",
      "indices": ["test"],
      "uuid": "7cdWedW7RC6FMSktlZTCDw"
    }
  ]
}

Delete a snapshot

Delete a snapshot from a repository.

Aiven Console

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.

OpenSearch API

Use the Delete Snapshot native OpenSearch API endpoint.

Aiven API

curl -s -X DELETE \
--url "https://api.aiven.io/v1/project/{project_name}/service/{service_name}/opensearch/_snapshot/aws-repo/first-snapshot" \
--header "Authorization: Bearer $TOKEN"
--header "Content-Type: application/json"

Example response:

{
  "acknowledged": true
}

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.