Index Service API

  • reference
The Index Service REST APIs provide configuration options for the Index Service.

APIs in this Section

For a list of the methods and URIs covered in these pages, see the tables below.

By default, the Index REST APIs below listen on port 9102, or 19102 for secure access. Note that the GSI Settings API listens on port 8091, or 18091 for secure access.

GSI Settings

HTTP Method URI Documented at

GET

/settings/indexes

Retrieve GSI Settings

POST

/settings/indexes

Set GSI Settings

Index Statistics

HTTP Method URI Documented at

GET

/api/v1/stats

Get Node Statistics

GET

/api/v1/stats/{keyspace}

Get Keyspace Statistics

GET

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

Get Index Statistics

Index Settings

HTTP Method URI Documented at

GET

/settings

Retrieve Index Settings

POST

/settings

Update Index Settings