# Create One Migration for One Local Managed Cluster to MongoDB Atlas

**POST /api/atlas/v2/groups/{groupId}/liveMigrations**

Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.

 Please make sure to validate your migration before initiating it.

 You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.

 **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. Deprecated versions: v2-{2023-01-01}

[Validate Migration](https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration)

## Servers
- https://cloud.mongodb.com: https://cloud.mongodb.com ()


## Authentication methods
- Service accounts
- Digest auth


## Parameters

### Path parameters
- **groupId** (string)
  Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

  **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.

### Query parameters
- **envelope** (boolean)
  Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
- **pretty** (boolean)
  Flag that indicates whether the response body should be in the prettyprint format.

### Body: application/vnd.atlas.2024-05-30+json (object)
One migration to be created.
- **destination** (object)
  Document that describes the destination of the migration.
- **dropDestinationData** (boolean)
  Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.
- **migrationHosts** (array[string])
  List of migration hosts used for this migration.
- **sharding** (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. If you don't wish to shard any collections on the destination cluster, leave this empty.
- **source** (object)
  Document that describes the source of the migration.


## Responses
### 201
Created

#### Body: application/vnd.atlas.2024-05-30+json (object)
- **_id** (string)
  Unique 24-hexadecimal digit string that identifies the migration job.
- **lagTimeSeconds** (integer(int64) | null)
  Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.
- **migrationHosts** (array[string])
  List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.
- **readyForCutover** (boolean)
  Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.
- **status** (string)
  Progress made in migrating one cluster to MongoDB Atlas.

  `NEW`: Someone scheduled a local cluster migration to MongoDB Atlas.

  `FAILED`: The cluster migration to MongoDB Atlas failed.

  `COMPLETE`: The cluster migration to MongoDB Atlas succeeded.

  `EXPIRED`: MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `"readyForCutover" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status.

  `WORKING`: The cluster migration to MongoDB Atlas is performing one of the following tasks:

  - Preparing connections to source and destination clusters.
  - Replicating data from source to destination.
  - Verifying MongoDB Atlas connection settings.
  - Stopping replication after the cut over.

### 400
Bad Request.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 401
Unauthorized.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 403
Forbidden.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 404
Not Found.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 500
Internal Server Error.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.


[Powered by Bump.sh](https://bump.sh)