Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas clusters onlineArchives

On this page

  • Options
  • Inherited Options
  • Related Commands

Manage online archives for your cluster.

Name
Type
Required
Description

-h, --help

false

help for onlineArchives

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.

  • atlas clusters onlineArchives create - Create an online archive for a collection in the specified cluster.

  • atlas clusters onlineArchives delete - Remove the specified online archive from your cluster.

  • atlas clusters onlineArchives describe - Return the details for the specified online archive for your cluster.

  • atlas clusters onlineArchives list - Return all online archives for your cluster.

  • atlas clusters onlineArchives pause - Pause the specfied online archive for your cluster.

  • atlas clusters onlineArchives start - Start a paused online archive from a cluster.

  • atlas clusters onlineArchives update - Modify the archiving rule for the specified online archive for a cluster.

  • atlas clusters onlineArchives watch - Watch for an archive to be available.

Back

list