Managed Databases API
Provision, scale, back up, and restore managed Postgres, Redis, ClickHouse, and Qdrant clusters.
Base path: /v1/workspaces/{workspace_id}/managed-databases
Requires managed-database / KubeBlocks enablement on the cell. Credentials are stored in Secrets — responses never return raw passwords.
See also: Customer Portal — Databases
Create / list
| Method | Path | Permission | Notes |
|---|---|---|---|
POST | /v1/workspaces/{workspace_id}/managed-databases | write | 202 — body: engine, name, resource_tier (small|medium) |
GET | same | read | List clusters |
Get / scale / delete
| Method | Path | Permission | Notes |
|---|---|---|---|
GET | …/{id} | read | |
PATCH | …/{id} | write | 202 — { "resource_tier": "medium" } |
DELETE | …/{id} | delete | 202 — backup_disposition: retain_30d | delete_now |
GET | …/{id}/runs/{run_id} | read | Poll async saga |
Backups and restore
| Method | Path | Permission |
|---|---|---|
POST / GET | …/{id}/backups | write / read |
GET / DELETE | …/{id}/backups/{backup_id} | read / delete |
PUT / GET | …/{id}/backup-schedule | write / read |
POST | …/{id}/restore | write (202) |
Restore body: backup_id, new_name, optional resource_tier, restore_time (PITR where supported).
Retained (orphan) backups:
| Method | Path | Permission |
|---|---|---|
GET | …/retained-backups | read |
POST | …/retained-backups/restore | write (202) |
Rotate credentials
POST /v1/workspaces/{workspace_id}/managed-databases/{id}/rotate-credentialsPermission: write · 202 Accepted