/api/ee/remote-sync

POST /api/ee/remote-sync/import

Changed on

Import Metabase content from configured Remote Sync source.

This endpoint will:

  • Fetch the latest changes from the configured source
  • Load the updated content using the serialization/deserialization system

If force=false (default) and there are unsaved changes in the Remote Sync collection, the import returns a 400 response.

Requires superuser permissions.

post/api/ee/remote-sync/import

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

Request body

branchstring

value must be a non-blank string.

expected_branchstring

value must be a non-blank string.

forceboolean
mergeboolean

Response

Successful response

messagestring nullable
status'success' required
task_idinteger nullable required

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      api operation id post-api-ee-remote-sync-import was added