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

atlas deployments search indexes create

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options

Create a search index for the specified deployment.

Command Syntax
atlas deployments search indexes create [indexName] [options]
Name
Type
Required
Description
indexName
string
false
Name of the index.
Name
Type
Required
Description
--collection
string
false

Name of the collection.

Mutually exclusive with --file.

--db
string
false

Name of the database.

Mutually exclusive with --file.

--deploymentName
string
false
Name of the deployment.
-f, --file
string
false

Name of the JSON index configuration file to use. To learn about the Atlas Search and Atlas Vector Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts. To learn about the Atlas Vector Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definition-avs.

Mutually exclusive with --db, --collection.

-h, --help
false
help for create
-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.
-w, --watch
false
Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option.
--watchTimeout
uint
false
Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command.
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.
← indexes
delete →