Index Service API

The Index service REST API provides configuration options for the Index service.

Description

Couchbase Server provides a Data, an Index, and a Query Service. Each service can be deployed and run either with one or more of the others, on a single node; or on its own node.

Table 1. Index-Service Endpoints
HTTP method	URI path	Description	Admin Role
GET	/pools/nodes	Retrieves information about nodes in a cluster.	Full, Cluster
POST	/pools/default	The `indexMemoryQuota` parameter is passed with an integer value (example: indexMemoryQuota=512) to set memory quota for the Index service.	Full, Cluster
GET	/settings/indexes	Retrieves parameter settings for the Index service. Available options are `indexerThreads`, `maxRollbackPoints`, `memorySnapshotInterval`, and `stableSnapshotInterval`.	Full, Cluster
POST	/settings/indexes	Sets the parameter settings for the Index service.	Full, Cluster
GET	/getIndexStatus	Retrieves status on defined indexes.	Full, Cluster
GET	/getIndexStatement	Retrieves a statement on defined indexes.	Full, Cluster