Docs Menu

Online Archive

The onlineArchives resource provides access to create, edit, delete, pause, and resume an online archive for a collection. You can also configure and manage online archives from the Atlas UI.

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

https://cloud.mongodb.com/api/atlas/v1.0

Method
Endpoint
Description
GET
Return all the online archives for a cluster.
GET
Return all the private endpoints for the online archives.
GET
Return the online archive specified by its ID.
GET
Return one private endpoint for the online archives.
GET
Download query logs for an online archive.
POST
Create an online archive for a collection.
POST
Add one AWS private endpoint for the online archives in the specified project.
PATCH
Update, pause, or resume an online archive by its ID.
DELETE
Delete an online archive by its ID.
DELETE
Delete one AWS private endpoint for the online archives in the specified project.
←  Create a Restore Job from an M2/M5 ClusterGet all Online Archives for Cluster →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.