MEmetabase
/api/ee/remote-sync

GET /api/ee/remote-sync/export-preflight

Changed on

Dry-run preview of what pushing the current state would do given the live remote branch, without writing anything. Drives the UI's push decision (force / new branch / merge).

Returns:

  • has_changes: whether the remote branch has advanced beyond the last synced version
  • clean: whether a 3-way merge would apply with no conflicts
  • conflicts: human-readable labels of the entities that conflict (empty when clean)
  • summary: counts of remote changes a merge would fold in
  • force_push_casualties: remote content a force push (rather than a merge) would discard, as {:deleted [labels] :overwritten [labels]}
  • reason: "history-rewritten" when the remote was force-pushed/rebased so no merge base exists

Requires superuser permissions.

get/api/ee/remote-sync/export-preflight

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

branchstring required

value must be a non-blank string.

Response

Successful response

cleanboolean required
conflictsstring[] required
has_changesboolean required
reasonstring nullable required

Changes