v12

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

POST /api/ee/serialization/export

Serialize and retrieve Metabase instance.

Outputs .tar.gz file with serialization results and an export.log file. On error outputs serialization logs directly.

post/api/ee/serialization/export

Query parameters

dirnamestring nullable

name of directory and archive file (default: <instance-name>-<YYYY-MM-dd_HH-mm>)

collections' db ids/entity-ids to serialize

all_collectionsboolean required
settingsboolean required
data_modelboolean required
field_valuesboolean required
database_secretsboolean required
continue_on_errorboolean required
full_stacktraceboolean required

Response

Successful response