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
March 16, 2025
+ 12
The Index service REST API provides configuration options for the Index service.

Description

The following table lists REST methods and URIs for the Index Service.

Table 1. Index-Service Endpoints
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 indexMemoryQuota parameter is passed with an integer value (example: indexMemoryQuota=512) to set memory quota for the Index service.

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 indexerThreads, maxRollbackPoints, memorySnapshotInterval, and stableSnapshotInterval.

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.