Details
-
Bug
-
Resolution: Unresolved
-
Major
-
None
-
7.0.0, 7.1.1
-
None
-
DOC-2022-S15, DOC-2022-S16
-
1
Description
The Backup Service API reference for "Import a Repository" does not have the cloud-specific parameters. This is confusing for users and makes them think that cloud object stores are not supported by Import a Repository API (even though they can do it via the Backup Service UI).
Import a Repository doc page: https://docs.couchbase.com/server/current/rest-api/backup-import-repository.html
The cloud-specific parameters is listed in the Backup Service API for "Create a Repository" – the same information should be available under Import a Repository (can be through a link). This is the info in "Create a Repository" – https://docs.couchbase.com/server/current/rest-api/backup-create-repository.html#cloud-specific-parameters
Note: There is a typo in the cloud-specific-parameters info in "Create a Repository" – the "cloud_credentials_region" should be "cloud_region".
Here's an example usage for cloud-specific parameters for "Import a Repository":
curl -v -X POST http://127.0.0.1:8097/api/v1/cluster/self/repository/import \
|
-u Administrator:password -d '{ "id":"import_test_repository", "archive":"s3://my-example-bucket/test_backups", "repo":"43842820-7265-412c-aacd-9b8f209ff436", "cloud_staging_dir":"/backups_staging/test_backups_staging",
|
"cloud_credentials_id":"AKxxx",
|
"cloud_credentials_key":"sfxxx",
|
"cloud_region":"us-west-2"
|
}'
|