Skip to navigation
API Referencedatabase-backups

Update backup configuration for a database cluster

Enable or disable encryption of this cluster’s backups. When enabling, provide a passphrase; keep it safe, as it is required to restore the resulting backups.

Authentication

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

Path parameters

clusterIdstringRequired
Database cluster ID

Request

This endpoint expects an object.
encryptionEnabledbooleanRequired

Whether backups for this cluster should be encrypted at rest. When enabled, backups are encrypted with AES-256-CFB.

passphrasestringOptionalformat: "^[\x21-\x7E]+$"12-256 characters

Passphrase used to encrypt new backups. Required when enabling encryption. Send a new passphrase with encryption enabled to change it. Must be 12–256 printable ASCII characters (letters, digits, symbols) with no spaces. Earlier backups still restore after a change, and a restore does not ask for the passphrase.

Response

Backup configuration update accepted

Errors

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