list_indexes
List indexes in a Couchbase cluster, filtered by bucket, scope, collection, or index name. Returns index definition, status, and last scan time.
Instructions
List indexes in the cluster with optional filtering by bucket, scope, collection, and index name.
Filters must be provided hierarchically: scope requires bucket, collection requires both, index requires all three.
Set return_raw_index_stats=True to get the unprocessed source row for each index.
Each result contains: name, definition (CREATE INDEX statement), status, isPrimary, bucket, scope, collection, lastScanTime. If a required field is missing, the entry contains warning and raw_index_stats instead.
Source depends on cluster version: v8+ queries system:indexes via the
query service (RBAC-scoped — the connected user sees only indexes on
keyspaces they can access); older clusters fall back to the admin-level
Index Service REST API /getIndexStatus.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bucket_name | No | ||
| scope_name | No | ||
| collection_name | No | ||
| index_name | No | ||
| return_raw_index_stats | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |