atlas api atlasSearch updateAtlasSearchIndexByName

On this page

experimental: Updates one Atlas Search index that you identified with its database, collection name, and index name.

Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This command is invoking the endpoint with OperationID: 'updateAtlasSearchIndexByName'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName

Syntax

Command Syntax

atlas api atlasSearch updateAtlasSearchIndexByName [options]

Name	Type	Required	Description
--clusterName	string	true	name of the cluster that contains the collection whose Atlas Search index you want to update
--collectionName	string	true	name of the collection that contains one or more Atlas Search indexes
--databaseName	string	true	label that identifies the database that contains the collection with one or more Atlas Search indexes
--envelope		false	flag that indicates whether Application wraps the response in an envelope JSON object
--file	string	false	path to the file which contains the api request contents
--groupId	string	true	unique 24-hexadecimal digit string that identifies your project
-h, --help		false	help for updateAtlasSearchIndexByName
--indexName	string	true	name of the Atlas Search index to update
--output	string	false	preferred api format, can be ["json", go-template] This value defaults to "json".
--output-file	string	false	file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
--pretty		false	flag that indicates whether the response body should be in the prettyprint format
--version	string	false	api version to use when calling the api call [options: "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30".

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.

Back

updateAtlasSearchIndex

updateAtlasSearchIndexDeprecated