Trigger backup
curl --request POST \
--url https://api.example.com/api/v1/databases/{id}/backupsimport requests
url = "https://api.example.com/api/v1/databases/{id}/backups"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v1/databases/{id}/backups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/databases/{id}/backups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/databases/{id}/backups"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/databases/{id}/backups")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/databases/{id}/backups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyBackups
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}/backupsimport requests
url = "https://api.example.com/api/v1/databases/{id}/backups"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/api/v1/databases/{id}/backups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/databases/{id}/backups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/databases/{id}/backups"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/databases/{id}/backups")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/databases/{id}/backups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyTriggers an asynchronous
Poll
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 queued",
"operation": {
"id": "op_01J...",
"type": "backup",
"status": "queued",
"stage": "queued",
"progress": 0
}
}
GET /api/v1/operations/{id} for status. The operation ID is also used by
the resulting backup artifact, audit event, and any customer webhook delivery.
Errors
| Status | Code | Description |
|---|---|---|
| 401 | UNAUTHORIZED | Missing or invalid API key |
| 403 | FORBIDDEN | Caller can view backups but cannot manage them |
| 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