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 16, 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 | Use the REST API?

    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.

    Swagger UIswagger

    Sync Gateway
     1.0 

    [ Base URL: localhost:4985 ]
    _attachments/sync-gateway-admin.yaml

    Documentation for the Sync Gateway Admin REST API.
    This page is generated from the Sync Gateway Admin Swagger spec, the exact same information is also available at developer.couchbase.com/mobile/swagger/sync-gateway-admin.

    attachment

    Groups all endpoints for attachment activities

    auth

    Groups all endpoints for authentication activities

    database

    Groups all endpoints for database activities

    default

    document

    Groups all endpoints for document-based activities

    query

    Groups all endpoints for query-based activities

    replication

    Groups all endpoints for sync and replication activities

    role

    Groups all endpoints for role-based activities

    server

    Groups all endpoints for server activities

    session

    Groups all endpoints for session activities

    user

    Groups all endpoints for user-based activities

    Models

    Error

    Related Content

    API Topics
    Reference
    Community