atlas api atlasSearch listAtlasSearchIndexesCluster

On this page

experimental: Returns all Atlas Search indexes on the specified cluster.

Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This command is invoking the endpoint with OperationID: 'listAtlasSearchIndexesCluster'. 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/listAtlasSearchIndexesCluster

Syntax

Command Syntax

atlas api atlasSearch listAtlasSearchIndexesCluster [options]

Name	Type	Required	Description
--clusterName	string	true	name of the cluster 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
--groupId	string	true	unique 24-hexadecimal digit string that identifies your project
-h, --help		false	help for listAtlasSearchIndexesCluster
--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

listAtlasSearchIndexes

listAtlasSearchIndexesDeprecated