Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas clusters delete

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Remove the specified cluster from your project.

The command prompts you to confirm the operation when you run the command without the --force option.

Deleting a cluster also deletes any backup snapshots for that cluster.

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

Command Syntax
atlas clusters delete <clusterName> [options]
Name
Type
Required
Description
clusterName
string
true
Name of the cluster to delete.
Name
Type
Required
Description
--force
false
Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action.
-h, --help
false
help for delete
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
-w, --watch
false
Flag that indicates whether to watch the command until it completes its execution or the watch times out. To set the time that the watch times out, use the --watchTimeout option.
--watchTimeout
int
false
Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command.
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.

Deleting cluster '<Name>'
# Remove a cluster named myCluster after prompting for a confirmation:
atlas clusters delete myCluster
# Remove a cluster named myCluster without requiring confirmation:
atlas clusters delete myCluster --force

Back

create