Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas clusters onlineArchives delete

On this page

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

Remove the specified online archive from your cluster.

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

Command Syntax
atlas clusters onlineArchives delete <archiveId> [options]
Name
Type
Required
Description
archiveId
string
true
Unique identifier of the online archive to delete.
Name
Type
Required
Description
--clusterName
string
true
Name of the cluster.
--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.
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.

Archive '<Name>' deleted
# Remove an online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster:
atlas clusters onlineArchives delete 5f189832e26ec075e10c32d3 --clusterName myCluster
← atlas clusters onlineArchives create