- This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.
List all Atlas Search indexes 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.
Syntax
atlas clusters search indexes list [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterName | string | true | Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. |
--collection | string | true | Name of the collection. |
--db | string | true | Name of the database. |
-h, --help | false | help for list | |
-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. |
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 the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Output
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>
Examples
# Return the JSON-formatted list of Atlas search indexes on the sample_mflix.movies database in the cluster named myCluster: atlas clusters search indexes list --clusterName myCluster --db sample_mflix --collection movies --output json