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

Retrieve GSI Settings

  • reference

Couchbase Server Enterprise Edition 7.6 reaches End of Life on March 31, 2027. Please upgrade to 8.0.x by following Upgrade, or contact Couchbase Support.
To retrieve the global secondary index settings use GET /settings/indexes.

Description

This endpoint returns the current index settings for the cluster.

HTTP Method and URI

GET http://<host>:8091/settings/indexes

Response Codes

Response Code Description

200

Success.

401

Unauthorized.

Sample Curl Command

The following example retrieves the global secondary index settings of the cluster that the node localhost is a part of.

curl -X GET -u 'Administrator:password' 'http://localhost:8091/settings/indexes'

Sample Response

200
{
  "redistributeIndexes": false,
  "numReplica": 0,
  "enablePageBloomFilter": false,
  "enableShardAffinity": false,
  "indexerThreads": 4,
  "memorySnapshotInterval": 200,
  "stableSnapshotInterval": 5000,
  "maxRollbackPoints": 2,
  "logLevel": "verbose",
  "storageMode": "plasma"
}
401

This response code returns an empty body.