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

RBAC Role — Endpoint Cross-reference

      +

      Server RBAC Role — Rest API endpoint cross reference tabley

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

      Admin

      This table identifies the RBAC roles required by Sync Gateway to execute endpoint actions. Couchbase Server 7.0.2 Developer Preview introduces new roles offering fine-grained access control; existing roles will remain available.

      For more on RBAC roles, see the Couchbase Server documentation: Couchbase Server Authorization Roles

      Table 1. REST API Admin Endpoints
      Rest API Endpoint Couchbase Server Roles

      Endpoint

      Method

      All Versions

      7.0.2
      Developer Preview

      {cluster}/_all_dbs

      GET / HEAD

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_config

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_config

      PUT

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_debug/fgprof

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_debug/fgprof

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/block

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/block

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/cmdline

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/cmdline

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/goroutine

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/goroutine

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/heap

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/heap

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/mutex

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/mutex

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/profile

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/profile

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/symbol

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/symbol

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/threadcreate

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/threadcreate

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/trace

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_debug/pprof/trace

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_expvar

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops, External Stats Reader

      {cluster}/_heap

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_logging

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_logging

      PUT / POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_post_upgrade

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_profile

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_profile/{profilename}

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_sgcollect_info

      DELETE

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_sgcollect_info

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/_sgcollect_info

      POST

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Dev Ops

      {cluster}/_stats

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops, External Stats Reader

      {cluster}/_status

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin,

      Sync Gateway Dev Ops

      {cluster}/{db}/

      DELETE

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Architect

      {cluster}/{db}/

      PUT

      Cluster Admin Role, Full Admin Role,

      Sync Gateway Architect

      {keyspace}/_compact

      POST

      Sync Gateway Role. Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {db}/_config

      GET

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {db}/_config

      PUT

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application

      {keyspace}/_config/import_filter

      DELETE

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {keyspace}/_config/import_filter

      GET

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {keyspace}/_config/import_filter

      PUT

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {keyspace}/_config/sync

      DELETE

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {keyspace}/_config/sync

      GET

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {keyspace}/_config/sync

      PUT

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {db}/_dump/{view}

      GET

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {keyspace}/_dumpchannel/{channel}

      GET

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {db}/_flush

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Dev Ops

      {db}/_offline

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {db}/_online

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {keyspace}/_purge

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application

      {keyspace}/_raw/{docid}

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {db}/_repair

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {db}/_replication/

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Replicator

      {db}/_replication/

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Replicator

      {db}/_replication/{replicationID}

      DELETE

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Replicator

      {db}/_replication/{replicationID}

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Replicator

      {db}/_replication/{replicationID}

      PUT

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Replicator

      {db}/_replicationStatus

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Replicator

      {db}/_replicationStatus/{replicationID}

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Replicator

      {db}/_replicationStatus/{replicationID}

      PUT

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Replicator

      {db}/_resync

      GET

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect

      {db}/_resync

      POST

      Sync Gateway Architect

      {keyspace}/_revtree/{docid}

      GET

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {db}/_role/

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application, Sync Gateway Application Read Only

      {db}/_role/

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application

      {db}/_role/{name}

      DELETE

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application

      {db}/_role/{name}

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application, Sync Gateway Application Read Only

      {db}/_role/{name}

      PUT

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application

      {db}/_session

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application

      {db}/_session/{sessionid}

      DELETE

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application

      {db}/_session/{sessionid}

      GET

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application, Sync Gateway Application Read Only

      {db}/_user/

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application, Sync Gateway Application Read Only

      {db}/_user/

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application

      {db}/_user/{name}

      DELETE

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application

      {db}/_user/{name}

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application, Sync Gateway Application Read Only

      {db}/_user/{name}

      PUT

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application

      {db}/_user/{name}/_session

      DELETE

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application

      {db}/_user/{name}/_session/{sessionid}

      DELETE

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Architect, Sync Gateway Application

      {db}/_view/{view}

      GET

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      Common Endpoints

      Table 2. Common Endpoints (with Admin)
      Rest API Endpoint Couchbase Server Release

      Endpoint

      Method

      Pre 7.0.2

      7.0.2+

      {cluster}/{db}/

      GET / HEAD

      Cluster Admin Role, Full Admin Role Read Only Admin

      Sync Gateway Dev Ops

      {cluster}/{db}/

      POST

      Cluster Admin Role, Full Admin Role

      Sync Gateway Application

      {keyspace}/_all_docs

      GET / HEAD / POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {keyspace}/_bulk_docs

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application

      {keyspace}/_bulk_get

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {keyspace}/_changes

      GET / HEAD / POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {db}/_design/{ddoc}

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {db}/_design/{ddoc}

      PUT

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application

      {db}/_design/{ddoc}

      DELETE

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application

      {db}/_design/{ddoc}/_view/{view}

      GET

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {db}/_ensure_full_commit

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {keyspace}/_revs_diff

      POST

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application

      {keyspace}/_local/{docid}

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {keyspace}/_local/{docid}

      PUT

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application

      {keyspace}/_local/{docid}

      DELETE

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application

      {keyspace}/{docid}

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {keyspace}/{docid}

      PUT

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway ApplicationSync Gateway Application

      {keyspace}/{docid}

      DELETE

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application

      {keyspace}/{docid}/{attach}

      GET / HEAD

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application, Sync Gateway Application Read Only

      {keyspace}/{docid}/{attach}

      PUT

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application

      {db}/_blipsync

      GET

      Sync Gateway Role, Bucket Admin, Bucket Application Access, Full Admin

      Sync Gateway Application

      Metrics Endpoints

      Table 3. REST API Admin Endpoints
      Rest API Endpoint Couchbase Server Release

      Endpoint

      Method

      Pre 7.0.2

      7.0.2+

      {cluster}/_metrics

      GET

      Cluster Admin Role, Full Admin Role, Read Only Admin

      Sync Gateway Dev Ops, External Stats Reader

      Related Content

      API Topics
      Reference
      Community

      Mobile Forum | Blog | Blog (Mobile) | Tutorials