/api/ee/remote-sync

GET /api/ee/remote-sync/has-remote-changes

Changed on

Check if there are new changes on the remote branch that can be pulled. Uses in-memory caching (configurable TTL via remote-sync-check-changes-cache-ttl-seconds setting).

Returns:

  • has_changes: true if remote version differs from last imported version, or if never imported
  • remote_version: current Git SHA on remote branch
  • local_version: Git SHA of last successful import (nil if never imported)
  • cached: true if result was served from cache
get/api/ee/remote-sync/has-remote-changes

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

force-refreshboolean

Request body

object required

Response

Successful response

branch_missingboolean
cachedboolean required
has_changesboolean required
local_versionstring nullable required
remote_versionstring nullable required

Changes

    • info

      added optional request body

    • info

      added the optional property to the response with the status

    • 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 get-api-ee-remote-sync-has-remote-changes was added