Navigation

View the List of Online Archives

Beta

Online archive is available as a Beta feature. The feature and the corresponding documentation may change at any time during the Beta stage.

You can view the list of online archives for a cluster through the Atlas UI and API.

View List of Online Archives Using the UI

To view the list of Online Archives:

1
2

The page displays the online archives for the cluster. For each online archive, you can see the following information:

Column Name Description
Archive Field The date field based on which documents are archived.
 

The status of the Online Archive. Value can be one of the following:

  • Pending - Indicates documents are queued for archive, but archiving has not yet started. In this state, documents queued for archiving are still on your active Atlas cluster, but cannot be modified.
  • Active - Indicates archiving has started. In this state, the documents that meet the criteria for archiving are archived or are being archived.
  • Paused - Indicates archiving has been temporarily stopped. In this state, previously archived documents continue to be available on the cloud object storage, but the specified archiving operation on active cluster is put on hold. You can resume archiving for paused archives at any time.
  • Deleted - Indicates online archive was deleted. When you delete an online archive, associated archived documents are removed from the cloud object storage.
Archive Last Updated The date when the archive was last modified.
Age Limit The number of days used to qualify documents for archiving.
Partition Fields The other commonly used query fields used for partitioning data on the cloud object storage.
Actions The operations that you can perform on the Online Archive.

Retrieve an Online Archive Using the API

To retrieve an online archive through the API, send a GET request to the onlineArchives endpoint with the unique ID of the online archive to retrieve. To learn more about the API syntax and options, see Get One Online Archive.

Retrieve All Online Archives for a Cluster Using the API

To retrieve all the online archives configured for a cluster using the API, send a GET request to the onlineArchives endpoint for the cluster. To learn more about the syntax and options, see Get all Online Archives for Cluster.