Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas clusters onlineArchives

Manage online archives for your cluster.

Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

Name
Type
Required
Description

-h, --help

false

help for onlineArchives

Name
Type
Required
Description

-P, --profile

string

false

  • 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

On this page