Serialization
API endpoints for Serialization.
POST /api/ee/serialization/export
Serialize and retrieve Metabase instance.
Parameters:
dirname
: str, name of directory and archive file (default:<instance-name>-<YYYY-MM-dd_HH-mm>
)all_collections
: bool, serialize all collections (default: true, unless you specifycollection
)collection
: array of int, db id of a collection to serializesettings
: bool, if Metabase settings should be serialized (default:true
)data_model
: bool, if Metabase data model should be serialized (default:true
)field_values
: bool, if cached field values should be serialized (default:false
)database_secrets
: bool, if details how to connect to each db should be serialized (default:false
)
Outputs .tar.gz file with serialization results and an export.log
file.
On error just returns serialization logs.
You must be a superuser to do this.
PARAMS:
-
all_collections
nullable value must be a valid boolean string (‘true’ or ‘false’). -
collection
nullable vector of value must be an integer greater than zero., or regex pattern matching “^eid:.{21}$”. -
settings
nullable value must be a valid boolean string (‘true’ or ‘false’). -
data_model
nullable value must be a valid boolean string (‘true’ or ‘false’). -
field_values
nullable value must be a valid boolean string (‘true’ or ‘false’). -
database_secrets
nullable value must be a valid boolean string (‘true’ or ‘false’). -
dirname
POST /api/ee/serialization/import
Deserialize Metabase instance from an archive generated by /export.
Parameters:
file
: archive encoded asmultipart/form-data
(required).
Returns logs of deserialization.
You must be a superuser to do this.
PARAMS:
raw-params
Read docs for other versions of Metabase.