Trigger backup
curl --request POST \
--url https://api.example.com/api/v1/databases/{id}/backupsBackups
Trigger backup
Start an asynchronous database backup/export.
POST
/
api
/
v1
/
databases
/
{id}
/
backups
Trigger backup
curl --request POST \
--url https://api.example.com/api/v1/databases/{id}/backupsTriggers an asynchronousDocumentation Index
Fetch the complete documentation index at: https://docs.dbhost.app/llms.txt
Use this file to discover all available pages before exploring further.
pg_dump backup/export. The request returns immediately while the backup runs in the background.
Path parameters
| Parameter | Type | Description |
|---|---|---|
id | uuid | Database 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
| Status | Code | Description |
|---|---|---|
| 401 | UNAUTHORIZED | Missing or invalid API key |
| 404 | DATABASE_NOT_FOUND | Database doesn’t exist, isn’t owned by this user, or isn’t in scope for this key |
| 500 | AGENT_ERROR | The VPS agent failed to start the backup |
⌘I