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

MongoDB Cloud Migration Service API

Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.

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

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

This API exposes 8 operations across 7 paths, and defines 16 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.

8 operations 7 paths 16 schemas 1 DELETE3 GET3 POST1 PUT

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
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Cloud Migration Service 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 8

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

Cloud Migration Service 8

Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB…

POST
/api/atlas/v2/groups/{groupId}/liveMigrations
Create One Migration for One Local Managed Cluster to MongoDB Atlas
createGroupLiveMigration 3 params body → 201400401403404429500
POST
/api/atlas/v2/groups/{groupId}/liveMigrations/validate
Validate One Migration Request
validateGroupLiveMigrations 3 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}
Return One Migration Validation Job
getGroupLiveMigrationValidateStatus 3 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}
Return One Migration Job
getGroupLiveMigration 4 params → 200401403404429500
PUT
/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover
Cut Over One Migrated Cluster
cutoverGroupLiveMigration 4 params → 202400401403404429500
GET
/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects
Return All Projects Available for Migration
listOrgLiveMigrationAvailableProjects 3 params → 200400401403404429500
DELETE
/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens
Remove One Link-Token
deleteOrgLiveMigrationLinkTokens 2 params → 204400401403404429500
POST
/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens
Create One Link-Token
createOrgLiveMigrationLinkToken 3 params body → 200400401403404429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are AvailableClustersDeployment (11 properties), Source (7 properties), LiveMigrationRequest20240530 (7 properties), ApiError (6 properties). Each schema is shown below with its type and property counts.

Source
object
Document that describes the source of the migration.
7 properties 4 required
ApiError
object
6 properties 2 required
Link
object
2 properties
FieldViolation
object
2 properties 2 required
LiveMigrationResponse
object
5 properties
ShardingRequest
object
Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher…
2 properties 2 required
ShardKeys
object
Document that configures the shard key on the destination cluster.
1 property 1 required
Destination
object
Document that describes the destination of the migration.
4 properties 3 required
LiveImportAvailableProject
object
4 properties 4 required
LiveImportValidation
object
5 properties
ShardEntry
object
Sharding configuration for a collection to be sharded on the destination cluster.
3 properties 3 required
AvailableClustersDeployment
object
Deployments that can be migrated to MongoDB Atlas.
11 properties 6 required
BadRequestDetail
object
Bad request detail.
1 property
TargetOrg
object
1 property 1 required
TargetOrgRequest
object
1 property
LiveMigrationRequest20240530
object
7 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-cloud-migration-service-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
MongoDB Atlas App Services Admin API
MongoDB Access Tracking API
MongoDB Activity Feed API
MongoDB Alert Configurations API
MongoDB Alerts API
MongoDB Atlas Search API
MongoDB Auditing API
MongoDB AWS Clusters DNS API
MongoDB Cloud Backups API
MongoDB Cloud Provider Access API
MongoDB Cluster Outage Simulation API
Where this information came from

This is an independent, third-party profile of MongoDB Cloud Migration Service 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.