Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Admin REST API

    March 23, 2025
    + 12

    Description of the Sync Gateway Admin REST API
    Use the API explorer to find out more about Sync Gateway’s endpoints by functionality.

    Related REST API topics: Public REST API | Metrics REST API

    Content Blocking

    Couchbase Mobile’s API documentation utilizes Swagger UI to deliver an interactive and dynamic user experience. The page will not function correctly if your organization’s security policies restricts access to this type of content — instead see the alternate statics page Admin REST API (Static Page)

    Introduction

    The Admin REST API is for administrator use only, and hence is not accessible from the clients directly.

    To allow users to access the Admin API up you need to create a Couchbase Server-based RBAC-user for them — see: REST API Access.

    Couchbase recommends that you do not expose the Sync Gateway admin interface to the internet. Due to this, features such as CORS are not supported on the admin interface.

    For document changes sent to Sync Gateway through the Admin REST API, the Sync Function executes with admin privileges.
    Calls to requireUser, requireAccess and requireRole will be no-ops, and will always appear successful.

    API Explorer

    The API explorer below groups all the endpoints by functionality. You can click on a label to expand the list of endpoints and also generate a curl request for each endpoint.

    Each endpoint description specifies its RBAC role requirements, but see RBAC Roles and the Couchbase Server documentation here Couchbase Server Authorization Roles if further information is required.

    Swagger UIswagger

    Sync Gateway
     3.1 
    OAS3

    _attachments/bundled-admin.yaml

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

    Sync Gateway Quickstart | Couchbase Docs
    Server
    Computed URL:http://localhost:4985

    Server variables

    protocol
    hostname

    Authentication

    Manage authentication

    Database Configuration

    Configure Sync Gateway databases

    Database Management

    Create and manage Sync Gateway databases

    Database Security

    Create and manage database users and roles

    default

    Document

    Create and manage documents and attachments

    Metrics

    Get Sync Gateway statistics

    OpenID Connect

    Manage OpenID Connect

    Profiling

    Generate information to help debug and fine-tune Sync Gateway

    Replication

    Create and manage inter-Sync Gateway replications

    Server

    Manage server activities

    Session

    Manage user sessions

    Unsupported

    Endpoints that are not supported by Sync Gateway

    Models

    Related Content

    API Topics
    Reference
    Community

    Mobile Forum | Blog | Blog (Mobile) | Tutorials