get_search_index_definition
Retrieve the full definition of a Couchbase Search (FTS) index by name, specifying bucket and scope for scoped indexes or omitting both for cluster-level lookups.
Instructions
Get the full definition of a single Search (FTS) index.
Pass both bucket_name and scope_name together to look up a scope-level (scoped) index in that scope, or omit both to look up a cluster-level ("legacy") index. Passing only one of the two is invalid — Couchbase allows the same index name to exist in different scopes, so the location must be stated explicitly rather than guessed.
Returns {"success": True, "name", "source_type", "idx_type", "source_name", "uuid", "params" (mapping/analyzer configuration), "source_uuid", "source_params", "plan_params" (num replicas/partitions), "bucket", "scope"}. If no index with this name exists at the given location, returns {"success": False, "error": ...} — confirm the exact name and location first with list_search_indexes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| index_name | Yes | ||
| scope_name | No | ||
| bucket_name | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||