atlas api performanceAdvisor setServerlessAutoIndexing
On this page
experimental: Set whether the Serverless Auto Indexing feature is enabled.
This endpoint sets a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026.
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/setServerlessAutoIndexing.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api performanceAdvisor setServerlessAutoIndexing [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--clusterName | string | true | human-readable label that identifies the cluster |
--enable | true | value that we want to set for the Serverless Auto Indexing toggle | |
--groupId | string | true | unique 24-hexadecimal digit string that identifies your project |
-h, --help | false | help for setServerlessAutoIndexing | |
--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: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01". |
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. |