Navigation

Pause and Resume Archiving

You can pause and resume archiving from the Atlas UI and API. When you pause, previously archived documents continue to be available on the cloud object storage for querying, but archiving activity for the collection on your Atlas cluster is stopped until you resume archiving. You will continue to incur costs for storage on the cloud object storage and for reading data. When you resume archiving, data that meets the criteria for archiving is archived.

You can pause an online archive and create another online archive for the same namespace and partition fields as the paused online archive, but only one online archive can be Active. So, if you try to resume a paused online archive when another online archive for the same namespace is Active, the resume operation will fail. You must either delete or pause the Active online archive to resume archiving for the paused online archive.

To pause archiving, in your Atlas UI:

1
  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
  3. If the Clusters page is not already displayed, click Clusters in the sidebar.
2
  1. Click the name of the cluster.
  2. Click the Online Archive tab to view the list of online archives, if any, for the cluster.
3

You can:

  • Pause Archive (only if state is Active)
  • Edit Archiving Rule
  • Delete Archive
  • Resume Archive (only if state is Paused)
4

To resume archiving, in your Atlas UI:

1
  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
  3. If the Clusters page is not already displayed, click Clusters in the sidebar.
2

The list of Online Archives displays.

3

You can:

  • Pause Archive (only if state is Active)
  • Edit Archiving Rule
  • Delete Archive
  • Resume Archive (only if state is Paused)
4
Note

The Resume Archive option is only visible for online archives in Paused state.

To pause an active online archive and/or to resume a paused online archive through the API, send a PATCH request to the onlineArchives endpoint with the unique ID of the online archive to pause or resume. To learn more about the API syntax and options, see Update an Online Archive.

Give Feedback

On this page

  • Pause Archiving Through the UI
  • Resume Archiving Through the UI
  • Pausing and Resuming Through the API