API docs by Redocly

Sync Gateway (3.2)

Download OpenAPI specification:Download

License: Business Source License 1.1 (BSL)

Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server

Sync Gateway Quickstart | Couchbase Docs

Prometheus

Endpoints for use with Prometheus

Debugging/monitoring runtime stats in Prometheus Exposition format

Returns Sync Gateway statistics and other runtime variables in Prometheus Exposition format.

Required Sync Gateway RBAC roles:

  • Sync Gateway Architect
  • Sync Gateway Dev Ops
  • External Stats Reader

Responses

Debugging/monitoring runtime stats in Prometheus Exposition format

Returns Sync Gateway statistics and other runtime variables in Prometheus Exposition format.

Required Sync Gateway RBAC roles:

  • Sync Gateway Architect
  • Sync Gateway Dev Ops
  • External Stats Reader

Responses

Server

Check if API is available

Returns OK status if API is available.

Responses

Response samples

Content type
text/plain
OK

Check if API is available

Returns OK status if API is available.

Responses

Get all Sync Gateway statistics

This returns a snapshot of all metrics in Sync Gateway for debugging and monitoring purposes.

This includes per database stats, replication stats, and server stats.

Required Sync Gateway RBAC roles:

  • Sync Gateway Architect
  • Sync Gateway Dev Ops
  • External Stats Reader

Responses