MEmetabase
/api/ee/serialization

POST /api/ee/serialization/export

Changed on

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

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Query parameters

dirnamestring nullable

name of directory and archive file (default: <instance-name>-<YYYY-MM-dd_HH-mm>): 1-255 characters from A-Z a-z 0-9 _ - . %, not starting with . or -

collections' db ids/entity-ids to serialize

all_collectionsboolean

Serialize all collections (true unless you specify collection)

settingsboolean

Serialize Metabase settings

data_modelboolean

Serialize Metabase data model

field_valuesboolean

Serialize cached field values

continue_on_errorboolean

Do not break execution on errors

full_stacktraceboolean

Show full stacktraces in the logs

Response

Successful response

Changes

  • b56d43be5817Revision changes
    • warning

      deleted the query request parameter database_secrets

    • info

      the query request parameter all_collections became optional

    • info

      the query request parameter continue_on_error became optional

    • info

      the query request parameter data_model became optional

    • info

      the query request parameter field_values became optional

    • info

      the query request parameter full_stacktrace became optional

    • info

      the query request parameter settings became optional

  • 78297d193ca4Revision changes
    • info

      api operation id post-api-ee-serialization-export was added