atlas api atlasSearch
Public Preview: please provide feedback: Returns, adds, edits, and removes Atlas Search indexes for the specified cluster.
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.
Also returns and updates user-defined analyzers for the specified cluster.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for atlasSearch |
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. |
Related Commands
atlas api atlasSearch createAtlasSearchDeployment - Public Preview: please provide feedback: Creates Search Nodes for the specified cluster.
atlas api atlasSearch createAtlasSearchIndex - Public Preview: please provide feedback: Creates one Atlas Search index on the specified collection.
atlas api atlasSearch createAtlasSearchIndexDeprecated - Public Preview: please provide feedback: Creates one Atlas Search index on the specified collection.
atlas api atlasSearch deleteAtlasSearchDeployment - Public Preview: please provide feedback: Deletes the Search Nodes for the specified cluster.
atlas api atlasSearch deleteAtlasSearchIndex - Public Preview: please provide feedback: Removes one Atlas Search index that you identified with its unique ID.
atlas api atlasSearch deleteAtlasSearchIndexByName - Public Preview: please provide feedback: Removes one Atlas Search index that you identified with its database, collection, and name.
atlas api atlasSearch deleteAtlasSearchIndexDeprecated - Public Preview: please provide feedback: Removes one Atlas Search index that you identified with its unique ID.
atlas api atlasSearch getAtlasSearchDeployment - Public Preview: please provide feedback: Returns the Search Nodes for the specified cluster.
atlas api atlasSearch getAtlasSearchIndex - Public Preview: please provide feedback: Returns one Atlas Search index that you identified with its unique ID.
atlas api atlasSearch getAtlasSearchIndexByName - Public Preview: please provide feedback: Returns one Atlas Search index that you identified with its database, collection name, and index name.
atlas api atlasSearch getAtlasSearchIndexDeprecated - Public Preview: please provide feedback: Returns one Atlas Search index in the specified project.
atlas api atlasSearch listAtlasSearchIndexes - Public Preview: please provide feedback: Returns all Atlas Search indexes on the specified collection.
atlas api atlasSearch listAtlasSearchIndexesCluster - Public Preview: please provide feedback: Returns all Atlas Search indexes on the specified cluster.
atlas api atlasSearch listAtlasSearchIndexesDeprecated - Public Preview: please provide feedback: Returns all Atlas Search indexes on the specified collection.
atlas api atlasSearch updateAtlasSearchDeployment - Public Preview: please provide feedback: Updates the Search Nodes for the specified cluster.
atlas api atlasSearch updateAtlasSearchIndex - Public Preview: please provide feedback: Updates one Atlas Search index that you identified with its unique ID.
atlas api atlasSearch updateAtlasSearchIndexByName - Public Preview: please provide feedback: Updates one Atlas Search index that you identified with its database, collection name, and index name.
atlas api atlasSearch updateAtlasSearchIndexDeprecated - Public Preview: please provide feedback: Updates one Atlas Search index that you identified with its unique ID.