Docs Menu

Docs HomeLaunch & Manage MongoDBMongoDB Atlas

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 Serverless Instances

Serverless instances don't support this feature at this time. To learn more, see 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 and partition fields as the paused online archive, but 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 will fail. You must either delete or pause the Active online archive to resume archiving for the paused online archive.

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

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.

Tip

See: Related Links

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.

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 Database Deployments page is not already displayed, click Database 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 Archiving (only if state is Active)

  • Edit Archive

  • Delete Archive

  • Resume Archiving (only if state is Paused)

4

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.

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 Database Deployments page is not already displayed, click Database in the sidebar.

2

The list of Online Archives displays.

3

You can:

  • Pause Archiving (only if state is Active)

  • Edit Archive

  • Delete Archive

  • Resume Archiving (only if state is Paused)

4

Note

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

←  Manage Private Endpoints for Online ArchivesBack Up Online Archive Data →