name: Couchbase Sync Gateway Capabilities
description: >-
  Workflow capabilities exposed by the Couchbase Sync Gateway Public REST API
  for mobile and edge document synchronization and authentication.
url: https://docs.couchbase.com/sync-gateway/current/rest-api.html
version: '1.0'
modified: '2026-04-28'
api: Couchbase Sync Gateway Public REST API
baseURL: https://localhost:4984
capabilities:
  - name: Document Synchronisation
    description: Read, write, and replicate documents between Couchbase Lite clients and Couchbase Server.
    inputs:
      - document id
      - revision
    outputs:
      - JSON document
      - revision metadata
  - name: Changes Feed
    description: Stream incremental document changes for offline-first replication.
    inputs:
      - since sequence
      - filter
    outputs:
      - change events
  - name: User Authentication
    description: Authenticate mobile users via session cookies, basic auth, or external OIDC providers.
    inputs:
      - credentials
    outputs:
      - session token
useCases:
  - name: Offline-First Mobile Apps
    description: Couchbase Lite clients synchronise data with Sync Gateway when online, falling back to local storage offline.
    capabilities:
      - Document Synchronisation
      - Changes Feed
  - name: Per-User Data Access
    description: Authenticate users and constrain replicated documents per channel and role.
    capabilities:
      - User Authentication
      - Document Synchronisation