Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas serverless update

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output

Updates one serverless instance in the specified project.

To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Command Syntax
atlas serverless update <instanceName> [options]
Name
Type
Required
Description
instanceName
string
true
Human-readable label that identifies your serverless instance.
Name
Type
Required
Description
--disableServerlessContinuousBackup
false

Disables Serverless Continuous Backup for your serverless instance. If disabled the serverless instance uses Basic Backup.

Mutually exclusive with --enableServerlessContinuousBackup.

--disableTerminationProtection
false

Disables termination protection for your cluster. You can delete a cluster with termination protection disabled.

Mutually exclusive with --enableTerminationProtection.

--enableServerlessContinuousBackup
false

Flag that enables Serverless Continuous Backup for your serverless instance. If enabled, the serverless instance does not use Basic Backup.

Mutually exclusive with --disableServerlessContinuousBackup.

--enableTerminationProtection
false

Enables termination protection for your cluster. You can't delete a cluster with termination protection enabled.

Mutually exclusive with --disableTerminationProtection.

-h, --help
false
help for update
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
--tag
key=value
false
List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance. Passing this flag replaces preexisting data.
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.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

Serverless instance <Name> updated.
← list
watch →