atlas api performanceAdvisor listDropIndexes
On this page
experimental: Returns the indexes that the Performance Advisor suggests to drop.
The Performance Advisor suggests dropping unused, redundant, and hidden indexes to improve write performance and increase storage space. To use this resource, the requesting API Key must have the Project Read Only role.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api performanceAdvisor listDropIndexes [options]
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 listDropIndexes | |
--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) |
--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". |
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. |