Schema & Table Metadata
User-accessible endpoints to inspect database structure — list tables in a schema and fetch column-level metadata for any table.
No X-Server-Key required.
List Tables
Returns all tables available under a given database schema.
GET /minimal/rest/meta/v1/table/list?type={db_type}&schema={db_name}
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
type | string | ✅ Yes | Database type — ms, pg, ma, or ch |
schema | string | ✅ Yes | Database name to list tables from |
Database type values
| Value | Database |
|---|---|
ms | MySQL |
pg | PostgreSQL |
ma | MariaDB |
ch | ClickHouse |
Required Headers
| Header | Description |
|---|---|
X-Project-Id | Project identifier |
X-Org-Id | Organisation identifier |
X-User-Id | Authenticated user's identifier |
X-User-Roles | Comma-separated roles (e.g., admin,user) |
Table Detail
Returns column-level metadata for a specific table — column names, types, nullability, and primary key info.
GET /minimal/rest/meta/v1/table/detail?type={db_type}&schema={db_name}&table={table}
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
type | string | ✅ Yes | Database type — ms, pg, ma, or ch |
schema | string | ✅ Yes | Database name the table belongs to |
table | string | ✅ Yes | Table name to fetch metadata for |
Required Headers
| Header | Description |
|---|---|
X-Project-Id | Project identifier |
X-Org-Id | Organisation identifier |
X-User-Id | Authenticated user's identifier |
X-User-Roles | Comma-separated roles (e.g., admin,user) |
Common Errors
| Code | Cause |
|---|---|
400 | Missing or invalid query parameter (type, schema, or table) |
401 | Missing X-User-Id header |
404 | Schema or table not found — check schema and table query params |
406 | Unsupported type value — use ms, pg, ma, or ch |