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

atlas deployments search indexes describe

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output

Describe a search index for the specified deployment.

Command Syntax
atlas deployments search indexes describe [indexId] [options]
Name
Type
Required
Description
indexId
string
false
ID of the index.
Name
Type
Required
Description
--deploymentName
string
false
Name of the deployment.
-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.
--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.
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 STATUS TYPE
<IndexID> <Name> <Database> <CollectionName> <Status> <Type>

Back

delete