2.8 KiB
Return to top
Create Backup
============================================================================================================
POST
/databases/{uuid}/backups
Create a new scheduled backup configuration for a database
Authorizations
bearerAuth
Go to Keys & Tokens / API tokens and create a new token. Use the token as the bearer token.
Type
HTTP (bearer)
Parameters
Path Parameters
uuid*
UUID of the database.
Type
string
Required
Request Body
application/json
SchemaJSON
JSON
{
"frequency": "string",
"enabled": true,
"save_s3": false,
"s3_storage_uuid": "string",
"databases_to_backup": "string",
"dump_all": false,
"backup_now": true,
"database_backup_retention_amount_locally": 0,
"database_backup_retention_days_locally": 0,
"database_backup_retention_max_storage_locally": 0,
"database_backup_retention_amount_s3": 0,
"database_backup_retention_days_s3": 0,
"database_backup_retention_max_storage_s3": 0,
"timeout": 3600
}
Responses
201400401404422
Backup configuration created successfully
Content-Type
application/json
SchemaJSON
JSON
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"message": "Backup configuration created successfully."
}
POST
/databases/{uuid}/backups
Playground
Authorization
bearerAuth
Variables
Key
Value
uuid*
Body
Try it out
Samples
Powered by VitePress OpenAPI