A newer version of this documentation is available.

View Latest

Index Service API

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

Description

Couchbase Server has data, index, and query services that can be enabled. All of services can be enabled on a Couchbase Server node or a single service can be enabled on a Couchbase Server node. Each node is as a member of a cluster.

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