Get a Search Index Definition from the Web Console

Use the Couchbase Server Web Console to copy and paste a JSON Search index definition for use in the REST API or another cluster.

You cannot export a Search index definition as a downloadable file. You can only copy the Search index definition from an existing index.

Prerequisites

You have the Search Service enabled on a node in your cluster. For more information about how to deploy a new node and Services on your cluster, see Manage Nodes and Clusters.
You have a bucket with scopes and collections in your cluster. For more information about how to create a bucket, see Create a Bucket.
Your user account has the Search Admin role for the bucket where you want to export an index definition.
You have created a Search index.

For more information about how to create a Search index, see Create a Basic Search Index with the Web Console or Create a Search Index with the REST API and curl/HTTP.
You have logged in to the Couchbase Server Web Console.

To copy a Search index definition from the Server Web Console:

When you create a Search index with the Server Web Console, you can also click copy to clipboard on the Index Definition Preview to copy the Search index definition.

You can paste the copied definition into a new .json file to import it into a new cluster, or use the definition with the Search REST API.

To import your Search index definition into a new Couchbase Server cluster through the Web Console, see Import a Search Index Definition with the Web Console.

To import your Search index into a Couchbase Capella cluster, see Import a Search Index Definition with the Capella UI.