Register a repository
POST/v1/repositories
Registers storage that backups are written to. A chunk repository keeps deduplicated backups through the s3, rados or posix driver. An rbd tier keeps recent backups as Ceph images that restores of new volumes and servers are cloned from. Access keys are sealed and never returned. Object lock is available on s3 only, and the chunk size is fixed for life. Warnings in the answer name what the service cannot check for itself.
Operator only: needs a system-scoped token.
Request
Responses
- 201
- 400
- 401
- 403
- 409
- 413
- 415
- 422
- 503
- default
Created
Bad Request.
invalid_request: The body is not a single JSON object, names a field this operation does not take, or gives a value of the wrong type.
Unauthorized.
unauthenticated: The token is missing, expired or not valid.
Forbidden.
forbidden: The token's roles do not grant repository:register.
Conflict.
conflict: A repository with this name is already registered.
Request Entity Too Large.
body_too_large: The body is larger than the service accepts.
Unsupported Media Type.
unsupported_media_type: The body is not sent as application/json.
Unprocessable Entity.
validation_failed: A field the kind or driver needs is missing: name, site_name, kind, driver, bucket, pool or prefix. A field is sent that the kind or driver does not use, such as bucket or chunk_size on an rbd tier, or pool on the s3 driver. object_lock is asked of a driver other than s3, or of an rbd tier. A driver is named for an rbd tier. chunk_size is not a power of two between 64 KiB and 64 MiB. A duration does not parse. The retention contract is incomplete or inconsistent. Access keys are sent for a driver other than s3, or without their pair. A site or replica id is not a UUID. environment_credentials is sent with access keys, or for an rbd tier.
repository_unreadable: The chunk repository is at another site, and listing it from here with the access keys given, or with none, failed. detail names the storage and the error, and nothing was saved. Send access keys that can list it, or environment_credentials.
Service Unavailable.
kms_unavailable: Access keys were sent, but no key manager is configured to seal them.
An error, as an RFC 7807 problem document.