Describe a search index for the specified deployment
Syntax
Command Syntax
atlas local search indexes describe [index_id] [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
index_id | string | false | ID of the index |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for describe | |
--deploymentName | string | true | Name of the deployment |
--password | string | false | Password for authenticating to MongoDB |
--username | string | false | Username for authenticating to MongoDB |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-o, --output | string | false | Output format |
-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 |