Serialization

API endpoints for 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.

You must be a superuser to do this.

PARAMS:

• field_values Serialize cached field values.

• data_model Serialize Metabase data model.

• collection collections’ db ids/entity-ids to serialize.

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

• continue_on_error Do not break execution on errors.

• settings Serialize Metabase settings.

• all_collections Serialize all collections (true unless you specify collection).

• full_stacktrace Show full stacktraces in the logs.

• database_secrets Serialize details how to connect to each db.

POST /api/ee/serialization/import

Deserialize Metabase instance from an archive generated by /export.

Parameters:

• file: archive encoded as multipart/form-data (required).

Returns logs of deserialization.

You must be a superuser to do this.

PARAMS:

• continue_on_error Do not break execution on errors.

• full_stacktrace Show full stacktraces in the logs.

• file .tgz with serialization data.

« Back to API index