ByCloud Docs
GuidesCLIAPISDK
post/v1/database-backups

Create database backup

Create a backup of a database instance

Request Body

required

Content-Type: application/json

instance_id

string<uuid>required

name

stringrequired

description

stringoptional

parent_id

string<uuid>optional

Parent backup ID for incremental backup

incremental

booleanoptional

Default: false

Responses

202

Backup creation initiated

Content-Type: application/json

database_backup

objectoptional
400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
404

Database instance not found

Content-Type: application/json

error

objectrequired
409

Instance is not in backupable state

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X POST "https://api.spo1.mycloud.com/v1/database-backups" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"instance_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "backup-2024-01-15",
"description": "string",
"parent_id": "550e8400-e29b-41d4-a716-446655440000",
"incremental": false
}'