Reference
Databases API
Instances, queries, users and backups.
Instances
GET
/api/v1/databases/enginesEngines, versions and default ports.
GET
/api/v1/databasesList instances.
POST
/api/v1/databasesCreate a managed instance.
POST
/api/v1/databases/externalRegister an external instance.
GET
/api/v1/databases/{id}Instance detail.
DELETE
/api/v1/databases/{id}Remove an instance.
POST
/api/v1/databases/{id}/controlBody
{"action": "start" | "stop" | "restart"}.GET
/api/v1/databases/{id}/connectionLogins with passwords and connection URLs. Audited.
GET
/api/v1/databases/{id}/jobs/{job_id}Result of any asynchronous call below.
http
POST /api/v1/databases{ "name": "main", "server_id": "c1f0…", "engine": "postgres", "version": "17", "database": "app" }Data
POST
/api/v1/databases/{id}/querysql, database, readonly (default true), max_rows (1–1000).POST
/api/v1/databases/{id}/explorewhat: databases, users, stats, tables or columns.POST
/api/v1/databases/{id}/redisaction: info, scan, get, delete or acl_list.GET
/api/v1/databases/{id}/metrics?hours=History samples: connections, size, memory, keys, ops/s.
POST
/api/v1/databases/{id}/exportDump one
database as .sql.gz. Returns a job id.GET
/api/v1/databases/{id}/exports/{job_id}Download a finished export. Audited.
POST
/api/v1/databases/{id}/import?database=Upload a .sql, .sql.gz or pg_dump file as the request body.
PUT
/api/v1/databases/{id}/tlsExternal databases:
tls_mode and optional ca.Databases and users
POST
/api/v1/databases/{id}/databasesCreate a database:
name, optional owner.DELETE
/api/v1/databases/{id}/databases/{name}Drop a database.
POST
/api/v1/databases/{id}/usersCreate a login:
username, database, access (Redis: key_pattern).POST
/api/v1/databases/{id}/users/{credential_id}/rotateSet a new random password.
DELETE
/api/v1/databases/{id}/users/{username}Drop a login.
POST
/api/v1/databases/{id}/attachAttach to an app:
application_id, env_key.Backups
GET
/api/v1/backupsBackup runs, newest first.
GET
/api/v1/backups/summaryTotals: backup count and size, recent failures and verified backups.
GET
/api/v1/backups/policiesEvery instance's policy.
PUT
/api/v1/backups/policies/{instance_id}enabled, every_hours, keep, databases.POST
/api/v1/backups/runBack up now:
instance_id, optional database.POST
/api/v1/backups/{run_id}/verifyTest-restore into a throwaway database.
POST
/api/v1/backups/{run_id}/restoremode: replace or new, with into.DELETE
/api/v1/backups/{run_id}Delete the backup locally and in storage.
GET
/api/v1/backups/jobs/{job_id}Status of a backup job.
GET
/api/v1/backups/settingsStorage settings, without secrets.
PUT
/api/v1/backups/settingsUpdate storage settings.
POST
/api/v1/backups/settings/test?server_id=Test storage from a server.
POST
/api/v1/backups/gdrive/connectStart Google sign-in; returns the consent URL.
DELETE
/api/v1/backups/gdrive/connectionDisconnect Google Drive and revoke access.