v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB
/api/ee/serialization

POST /api/ee/serialization/metadata/export

Get warehouse metadata (databases, tables, and fields) for all databases visible to the current user. References between rows are emitted as raw numeric ids (db_id, table_id, parent_id, fk_target_field_id).

Sections must be opted into with the with-databases, with-tables, and with-fields query parameters — they all default to false. The response is streamed for efficiency with large schemas.

Requires View dataCan view and Create queriesQuery builder only (or Query builder and native) permissions on each database and table.

post/api/ee/serialization/metadata/export

Query parameters

with-databasesboolean nullable required
with-tablesboolean nullable required
with-fieldsboolean nullable required

Response

Successful response