Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

atlas clusters search indexes describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Return the details for the search index for a cluster.

To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role.

Command Syntax
atlas clusters search indexes describe <indexId> [options]
Name
Type
Required
Description
indexId
string
true
ID of the index.
Name
Type
Required
Description
--clusterName
string
true
Name of the cluster.
-h, --help
false
help for describe
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false
Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

ID NAME DATABASE COLLECTION TYPE
<IndexID> <Name> <Database> <CollectionName> <Type>
# Return the JSON-formatted details for the search index with the ID 5f1f40842f2ac35f49190c20 for the cluster named myCluster:
atlas clusters search indexes describe 5f1f40842f2ac35f49190c20 --clusterName myCluster --output json
← atlas clusters search indexes delete