- 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 deployment.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
Syntax
atlas deployments search indexes list [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--collection | string | false | Name of the collection. |
--db | string | false | Name of the database. |
--deploymentName | string | false | Name of the deployment. |
-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. |
--password | string | false | Password for the user. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
--type | string | false | Type of deployment. Valid values are ATLAS or LOCAL. |
--username | string | false | Username for authenticating to MongoDB. |
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 STATUS TYPE <IndexID> <Name> <Database> <CollectionName> <Status> <Type>