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.

Admin REST API

      +

      Description of the Sync Gateway Admin REST API

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

      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 Reference

      The API reference groups all the endpoints by functionality.

      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.

      Related Content

      API Topics
      Reference
      Community

      Mobile Forum | Blog | Blog (Mobile) | Tutorials