Table Metadata

Fetch the column schema and metadata for any table in a connected database. Useful for inspecting table structure before building queries or custom API definitions.

---

Get Table Metadata

GET /minimal/system/api/v1/db/meta?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 (schema) to inspect
table	string	✅ Yes	Table name to fetch metadata for

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-Space-Id	Space identifier
X-User-Id	Authenticated user's identifier
X-User-Roles	Comma-separated roles (e.g., admin,user)
X-Server-Key	Server key from config.yml

Response

200 OK — returns column-level metadata for the specified table:

{
  "table": "users",
  "schema": "d3459kd98",
  "columns": [
    {
      "name": "id",
      "type": "int",
      "nullable": false,
      "primary_key": true,
      "default": null
    },
    {
      "name": "name",
      "type": "varchar(255)",
      "nullable": false,
      "primary_key": false,
      "default": null
    },
    {
      "name": "email",
      "type": "varchar(255)",
      "nullable": false,
      "primary_key": false,
      "default": null
    }
  ]
}

Common Errors

Code	Cause
400	Missing or invalid query parameter (type, schema, or table)
401	Missing X-User-Id header
403	Invalid or missing X-Server-Key
404	Table or schema not found — check schema and table query params
406	Unsupported type value — use ms, pg, ma, or ch