atlas api performanceAdvisor listClusterSuggestedIndexes

On this page

experimental: Returns the indexes that the Performance Advisor suggests.

The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. This command is invoking the endpoint with OperationID: 'listClusterSuggestedIndexes'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes

Syntax

Command Syntax

atlas api performanceAdvisor listClusterSuggestedIndexes [options]

Name	Type	Required	Description
--clusterName	string	true	human-readable label that identifies the cluster
--groupId	string	true	unique 24-hexadecimal digit string that identifies your project
-h, --help		false	help for listClusterSuggestedIndexes
--namespaces	stringArray	false	namespaces from which to retrieve suggested indexes
--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)
--processIds	stringArray	false	processIds from which to retrieve suggested indexes
--since	int	false	date and time from which the query retrieves the suggested indexes
--until	int	false	date and time up until which the query retrieves the suggested indexes
--version	string	false	api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05".

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

getServerlessAutoIndexing

listDropIndexes