PATCH
/databases/{uuid}/backups/{scheduled_backup_uuid}Update
Update a specific backup configuration for a given database, identified by its UUID and the backup ID
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
uuidstringrequired
UUID of the database.
scheduled_backup_uuidstringrequired
UUID of the backup configuration.
Database backup configuration data
backup_nowbooleanoptional
Whether to take a backup now or not. Needs a token with the deploy permission.
database_backup_retention_amount_locallyintegeroptional
Retention amount of the backup locally
database_backup_retention_amount_s3integeroptional
Retention amount of the backup in s3
database_backup_retention_days_locallyintegeroptional
Retention days of the backup locally
database_backup_retention_days_s3integeroptional
Retention days of the backup in s3
database_backup_retention_max_storage_locallynumberoptional
Max storage of the backup locally
database_backup_retention_max_storage_s3numberoptional
Max storage of the backup in S3
databases_to_backupstringoptional
Comma separated list of databases to backup
disable_local_backupbooleanoptional
Delete the local backup file after the upload to S3. Only allowed when save_s3 is true. Turning save_s3 off also turns this off.
dump_allbooleanoptional
Whether all databases are dumped or not
enabledbooleanoptional
Whether the backup is enabled or not
frequencystringoptional
Frequency of the backup
missing_backup_notification_daysintegeroptional
Alert after this many days without an execution; 0 disables alerts
s3_storage_uuidstringoptional
Primary S3 storage UUID. Sent without s3_storage_uuids, it selects this storage as the only destination; when it is already a destination, it becomes the primary destination and the other destinations stay.
s3_storage_uuidsarray<string>optional
UUIDs of every S3 storage the backup is uploaded to. Replaces the current destinations. When s3_storage_uuid is also sent, it must be in this list and becomes the primary destination; otherwise the first entry is the primary destination.
save_s3booleanoptional
Whether data is saved in s3 or not
timeoutintegeroptional
Backup job timeout in seconds (min: 60, max: 36000)
200Database backup configuration updated
400Invalid token.
messagestringoptional
401Unauthenticated.
messagestringoptional
403The token needs the deploy permission to use backup_now.
404Resource not found.
messagestringoptional
422Validation error.
errorsobjectoptional
messagestringoptional
Error handling
A 400 is returned: Invalid token. A 401 is returned: Unauthenticated. A 403 is returned: The token needs the deploy permission to use backup_now. A 404 is returned: Resource not found. A 422 is returned: Validation error.