Manage Aiven for OpenSearch® custom repositories in OpenSearch® API
Use the OpenSearch® API for configuring custom repositories in Aiven for OpenSearch to store snapshots in your cloud storage.
Prerequisites
- Maintenance updates applied for your service
- Security management enabled for your service
- Snapshot permissions and snapshot repository permissions configured
- Storage credentials
Limitations
- Supported storage services
- Amazon S3
- Google Cloud Storage (GCS)
- Microsoft Azure Blob Storage
- The following operations are not supported via native OpenSearch API:
- Using the native OpenSearch API requires providing storage credentials.
Register custom repositories
Each repository requires a unique name, a storage type (such as S3, Azure, or GCS), and the appropriate settings for the selected storage provider.
Use the Register Snapshot Repository native OpenSearch API endpoint.
View repository details
To view details on a repository, use the Get Snapshot Repository native OpenSearch API endpoint.
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