Docs Menu
Docs Home
/
Atlas
/
Backup, Restore, and Archive
/
Online Archive

Pause and Resume Archiving

On this page

  • Required Access
  • Pause Archiving Through the Atlas CLI
  • Pausing and Resuming Through the API
  • Pause Archiving Through the UI
  • Resume Archiving Through the Atlas CLI
  • Resume Archiving Through the UI

Important

Feature unavailable in Flex Clusters and Serverless Instances

Flex clusters and Serverless instances don't support this feature at this time. To learn more, see Atlas Flex Limitations and Serverless Instance Limitations.

You can pause and resume archiving from the Atlas CLI, 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 and archived data that meets the deletion age limit is deleted.

Atlas won't pause data expiration if you pause your Online Archive or Atlas cluster. Atlas will delete expired data.

You can pause an online archive and create another online archive for the same namespace. However, this second online archive cannot contain the same partition fields as the paused online archive. Additionally, only one online archive can be Active. If you try to resume a paused online archive when another online archive for the same namespace is Active, the resume operation fails. You must either delete or pause the Active online archive to resume archiving for the paused online archive.

Required Access

To update, pause, or resume an online archive, you must have Project Data Access Admin access or higher to the project.

Pause Archiving Through the Atlas CLI

To pause an online archive for a cluster using the Atlas CLI, run the following command:

atlas clusters onlineArchives pause <archiveId> [options]

To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas clusters onlineArchives pause.

Pausing and Resuming Through the API

To pause an active online archive or 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 syntax and options, see API.

Pause Archiving Through the UI

To pause archiving, in your Atlas UI:

1

In Atlas, go to the Clusters page for your project.

Warning

Navigation Improvements In Progress

We're currently rolling out a new and improved navigation experience. If the following steps don't match your view in the Atlas UI, see the preview documentation.

  1. If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. If it's not already displayed, click Clusters in the sidebar.

    The Clusters page displays.

2

Go to the Online Archive page for your cluster.

  1. Click your cluster's name.

  2. Click the Online Archive tab.

    The Online Archive page displays.

3

Click the ellipsis (...) in the Actions column for the online archive to display the list of allowed actions. You can:

  • Pause Archiving (only if state is Active)

  • Edit Archive

  • Delete Archive

  • Resume Archiving (only if state is Paused)

4

Select Pause Archiving from the ellipsis menu to temporarily stop archiving data in the collection.

Resume Archiving Through the Atlas CLI

To start a paused online archive for a cluster using the Atlas CLI, run the following command:

atlas clusters onlineArchives start <archiveId> [options]

To learn more about the command syntax and parameters, see the Atlas CLI documentation for atlas clusters onlineArchives start.

Resume Archiving Through the UI

To resume archiving, in your Atlas UI:

1

In Atlas, go to the Clusters page for your project.

Warning

Navigation Improvements In Progress

We're currently rolling out a new and improved navigation experience. If the following steps don't match your view in the Atlas UI, see the preview documentation.

  1. If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

  2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

  3. If it's not already displayed, click Clusters in the sidebar.

    The Clusters page displays.

2

Go to the Online Archive page for your cluster.

  1. Click your cluster's name.

  2. Click the Online Archive tab.

    The Online Archive page displays.

3

Click the ellipsis (...) in the Actions column for the online archive to display the list of allowed actions. You can:

  • Pause Archiving (only if state is Active)

  • Edit Archive

  • Delete Archive

  • Resume Archiving (only if state is Paused)

4

Select Resume Archiving from the ellipsis menu to start archiving.

Note

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

Back

Manage Private Endpoints

Next

Back Up Online Archive