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.
HTTP method | URI path | Port | Description | Admin Role |
---|---|---|---|---|
GET |
/pools/nodes |
8091 |
Retrieves information about nodes in a cluster. |
Full, Cluster |
POST |
/pools/default |
8091 |
The |
Full, Cluster |
GET |
/settings/indexes |
8091 |
Retrieves parameter settings for the Index service. |
Full, Cluster |
POST |
/settings/indexes |
8091 |
Sets the parameter settings for the Index service.
Available options are |
Full, Cluster |
GET |
/api/v1/stats |
9102 |
Retrieves statistics for the Index node. |
Full, Query Manage Index |
GET |
/api/v1/stats/[keyspace]/[index] |
9102 |
Retrieves statistics for an index. |
Full, Query Manage Index |
To retrieve the status of defined indexes, including the index keys and conditions, you can use the N1QL REST API to query the system:indexes catalog. |