/api/ee/remote-sync

POST /api/ee/remote-sync/test-connection

Changed on

Test whether the Remote Sync credentials can reach the git repository.

When called with an empty body, validates the currently saved URL and token. When the body provides remote-sync-url or remote-sync-token, those override the saved values — useful for verifying a new Personal Access Token before saving. An obfuscated token (matching the existing token's masked representation) is treated as "unchanged" and the stored token value is used for the test.

Only validates connection and authentication; branch existence is not checked here.

Returns {:status :success} on success. On failure, returns a 400 with a user-friendly error message describing the connection problem.

Requires superuser permissions.

post/api/ee/remote-sync/test-connection

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

remote-sync-tokenstring nullable
remote-sync-urlstring nullable

Response

Successful response

status'success' required

Changes