How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
MongoDB

MongoDB Online Archive API

Returns, adds, edits, or removes an online archive.

Documentation Provider Profile APIs.io OpenAPI GitHub

MongoDB Online Archive API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Online Archive. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 6 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://cloud.mongodb.com.

6 operations 3 paths 17 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
License
CC BY-NC-SA 3.0 US
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

MongoDB Online Archive API declares 2 security schemes for authenticating requests. It uses HTTP digest authentication (DigestAuth). It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow. By default, every request must be authenticated.

  • ServiceAccounts — Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Online Archive 6

Returns, adds, edits, or removes an online archive.

GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives
Return All Online Archives for One Cluster
listGroupClusterOnlineArchives 7 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives
Create One Online Archive
createGroupClusterOnlineArchive 4 params body → 200400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz
Download Online Archive Query Logs
downloadGroupClusterOnlineArchiveQueryLogs 6 params → 200400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}
Remove One Online Archive
deleteGroupClusterOnlineArchive 5 params → 204401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}
Return One Online Archive
getGroupClusterOnlineArchive 5 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}
Update One Online Archive
updateGroupClusterOnlineArchive 5 params body → 200400401403404409429500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are BackupOnlineArchive (14 properties), BackupOnlineArchiveCreate (14 properties), ApiError (6 properties), PartitionFieldView (3 properties). Each schema is shown below with its type and property counts.

CriteriaView
object
Rules by which MongoDB Cloud archives data. Use the criteria.type field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the d…
1 property
ApiError
object
6 properties 2 required
Link
object
2 properties
CreateDataProcessRegionView
object
Settings to configure the region where you wish to store your archived data.
1 property
FieldViolation
object
2 properties 2 required
BackupOnlineArchiveCreate
object
14 properties 3 required
DataExpirationRuleView
object
Rule for specifying when data should be deleted from the archive.
1 property
OnlineArchiveSchedule
object
Regular frequency and duration when archiving process occurs.
1 property 1 required
DailyScheduleView
object
1 required
BackupOnlineArchive
object
14 properties
DefaultScheduleView
object
1 required
DataProcessRegionView
object
Settings to configure the region where you wish to store your archived data.
1 property
PaginatedOnlineArchiveView
object
3 properties 1 required
PartitionFieldView
object
Metadata to partition this online archive.
3 properties 2 required
BadRequestDetail
object
Bad request detail.
1 property
WeeklyScheduleView
object
1 required
MonthlyScheduleView
object
1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-online-archive-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
AE Profile APIs.io
MongoDB Atlas App Services Admin API
AE Profile APIs.io
MongoDB Access Tracking API
AE Profile APIs.io
MongoDB Activity Feed API
AE Profile APIs.io
MongoDB Alert Configurations API
AE Profile APIs.io
MongoDB Alerts API
AE Profile APIs.io
MongoDB Atlas Search API
AE Profile APIs.io
MongoDB Auditing API
AE Profile APIs.io
MongoDB AWS Clusters DNS API
AE Profile APIs.io
MongoDB Cloud Backups API
AE Profile APIs.io
MongoDB Cloud Migration Service API
AE Profile APIs.io
MongoDB Cloud Provider Access API
AE Profile APIs.io
#Online Archive
← Back to M APIs
API Details
ID
mongodb:mongodb-online-archive-api
Base URL
https://cloud.mongodb.com/api/atlas/v2
Docs
https://www.mongodb.com/docs/atlas/api/
Provider
MongoDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mongodb-online-archive-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mongodb-online-archive-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of MongoDB Online Archive API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.