/api/ee/remote-sync

POST /api/ee/remote-sync/export

Changed on

Export the current state of the Remote Sync collection to a Source.

This endpoint will:

  • Fetch the latest changes from the source
  • Create a branch or subdirectory (depending on source support) If no branch is supplied, use the configured export branch
  • Export the Remote Sync collection via serialization to the branch or subdirectory
  • Commit the changes if possible
  • Sync to the source if possible

Requires superuser permissions.

post/api/ee/remote-sync/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

Request body

branchstring required

value must be a non-blank string.

forceboolean
mergeboolean
messagestring

value must be a non-blank string.

Response

Successful response

messagestring required
task_idinteger required

Changes