Skip to navigation
API Referencedatabase-infrastructure

Create a backup repository

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Path parameters

userClusterIdstringRequired
Infrastructure cluster ID

Request

This endpoint expects an object.
repoNamestringRequired
Name for the backup repository.
bucketstringRequired

Name of the S3 bucket backups are stored in. Provide the bucket name only — no path or account/tenant prefix.

endpointstringRequired

Hostname of your S3-compatible endpoint (for example, “s3.example.com”), optionally with a port. Provide the host only — connections always use HTTPS.

accessKeyIdstringRequired
S3 access key identifier with access to the bucket.
accessKeySecretstringRequired
S3 secret key paired with the access key.
pathPrefixstringOptional
Optional key prefix to store backups under, inside the bucket.

Response

Backup repository creation initiated

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error