Docs Home → MongoDB Command Line Interface
mongocli atlas clusters search indexes describe
mongocli atlas commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas commands until April 30, 2023.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 that has the Project Data Access Read/Write role.
Syntax
Command Syntax
mongocli atlas clusters search indexes describe <indexId> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
indexId | string | true | ID of the index. |
Options
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. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
ID NAME DATABASE COLLECTION <IndexID> <Name> <Database> <CollectionName>
Examples
# Return the JSON-formatted details for the search index with the ID 5f1f40842f2ac35f49190c20 for the cluster named myCluster: mongocli atlas clusters search indexes describe 5f1f40842f2ac35f49190c20 --clusterName myCluster --output json