atlas api clusters pinFeatureCompatibilityVersion

On this page

experimental: Pins the Feature Compatibility Version (FCV) to the current MongoDB version and sets the pin expiration date.

If an FCV pin already exists for the cluster, calling this method will only update the expiration date of the existing pin and will not repin the FCV. This command is invoking the endpoint with OperationID: 'pinFeatureCompatibilityVersion'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion

Syntax

Command Syntax

atlas api clusters pinFeatureCompatibilityVersion [options]

Name	Type	Required	Description
--clusterName	string	true	human-readable label that identifies this cluster
--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 pinFeatureCompatibilityVersion
--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

loadSampleDataset

revokeMongoDbEmployeeAccess