Docs Menu

Docs HomeLaunch & Manage MongoDBAtlas CLI

atlas clusters onlineArchives start

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output

Start a paused online archive from a 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 start <archiveId> [options]
Name
Type
Required
Description
archiveId
string
true
Unique identifier of the online archive to start.
Name
Type
Required
Description
--clusterName
string
true
Name of the cluster.
-h, --help
false
help for start
-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.
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.

Online archive '<Id>' started.
← atlas clusters onlineArchives pause