API Reference
A quick overview of dblumi's REST API — 56 endpoints across 11 resource groups.
This is a static summary. For the full interactive spec with request/response schemas, open
/api/docs/ (Swagger UI) inside your running dblumi instance.
Auth
Registration, login, sessions, OAuth, and password management.
/api/v1/auth/register Create a new user account /api/v1/auth/login Authenticate and receive a JWT /api/v1/auth/logout Revoke the current session /api/v1/auth/me Get the authenticated user profile /api/v1/auth/language Update user language preference /api/v1/auth/ws-token Get a short-lived WebSocket token /api/v1/auth/password-change Change current password /api/v1/auth/request-password-reset Request a password-reset email /api/v1/auth/reset-password Reset password with a token /api/v1/auth/keycloak Initiate Keycloak/OIDC login /api/v1/auth/keycloak/callback Keycloak OAuth callback Connections
Manage database connections (Postgres, MySQL, Oracle, SQLite).
/api/v1/connections List all connections /api/v1/connections Create a new connection /api/v1/connections/test-raw Test a connection before saving /api/v1/connections/:id Get a connection by ID /api/v1/connections/:id Update a connection /api/v1/connections/:id Delete a connection /api/v1/connections/:id/test Test an existing connection /api/v1/connections/:id/schema Get full schema (tables, columns, relations) /api/v1/connections/:id/table-count Count rows in a table Query
Execute SQL queries with streaming results.
/api/v1/query Execute a SQL query (SSE streaming) Saved Queries
Save, organize, share, and version queries.
/api/v1/saved-queries List all saved queries /api/v1/saved-queries Create a saved query /api/v1/saved-queries/reorder Reorder saved queries /api/v1/saved-queries/:id Get a saved query /api/v1/saved-queries/:id Update a saved query /api/v1/saved-queries/:id Delete a saved query /api/v1/saved-queries/:id/shares List sharing rules /api/v1/saved-queries/:id/shares Update sharing rules /api/v1/saved-queries/:id/versions List version history /api/v1/saved-queries/:id/versions/:versionId Label a version /api/v1/saved-queries/:id/messages List collaboration messages AI Copilot
Schema-aware SQL generation from natural language.
/api/v1/copilot Generate SQL from natural language (SSE streaming) Admin
User and group administration (admin role required).
/api/v1/admin/users List all users /api/v1/admin/users/:id Update a user (role, status) /api/v1/admin/users/:id Delete a user /api/v1/admin/groups List all groups /api/v1/admin/groups Create a group /api/v1/admin/groups/:id Update a group /api/v1/admin/groups/:id Delete a group /api/v1/admin/groups/:id/members List group members /api/v1/admin/groups/:id/members Add a member to a group /api/v1/admin/groups/:id/members/:userId Remove a member Database Users
Manage users and privileges on the target database.
/api/v1/connections/:id/db-users List database users /api/v1/connections/:id/db-users/:username/privileges Get user privileges /api/v1/connections/:id/db-users Create a database user /api/v1/connections/:id/db-users/:username Update a database user /api/v1/connections/:id/db-users/:username Delete a database user Import & Sync
Bulk data import and cross-database synchronization.
/api/v1/import Import data (CSV/SQL) into a table /api/v1/import/map-columns AI-powered column mapping /api/v1/sync Sync data between databases Settings
Instance-wide configuration.
/api/v1/settings/auth-providers List configured auth providers /api/v1/settings/copilot-info Get copilot configuration status Health
API availability check.
/api/health Returns 200 if the API is running Start your dblumi instance and open /api/docs/ for the interactive Swagger UI with request bodies, response schemas, and "Try it out" — powered by OpenAPI 3.0.