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

Index Service API

  • 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.
The Index service REST API provides configuration options for the Index service.

APIs in this Section

The REST API allows Index-Service indexes to be created and managed. For a list of the methods and URIs covered in these pages, see the table below.

HTTP Method URI Documented at

GET

/settings/indexes

Retrieve GSI Settings

POST

/settings/indexes

Set GSI Settings

GET

/api/v1/stats

Get Node Statistics

GET

/api/v1/stats/{keyspace}

Get Keyspace Statistics

GET

/api/v1/stats/{keyspace}/{index}

Get Index Statistics