Admin REST API
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.