Skip to main content
POST
/
api
/
v1
/
databases
/
{id}
/
backups
Trigger backup
curl --request POST \
  --url https://api.example.com/api/v1/databases/{id}/backups
Triggers an asynchronous pg_dump backup/export. The request returns immediately while the backup runs in the background.

​
Path parameters

ParameterTypeDescription
iduuidDatabase ID

​
Example

curl -X POST \
  -H "Authorization: Bearer dbh_your_api_key_here" \
  https://dbhost.app/api/v1/databases/550e8400-e29b-41d4-a716-446655440000/backups

​
Response

202 Accepted
{
  "message": "Backup started"
}

​
Errors

StatusCodeDescription
401UNAUTHORIZEDMissing or invalid API key
404DATABASE_NOT_FOUNDDatabase doesn’t exist, isn’t owned by this user, or isn’t in scope for this key
500AGENT_ERRORThe VPS agent failed to start the backup