# Return One Migration Job

**GET /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}**

Return details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource.


## 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.
- **liveMigrationId** (string)
  Unique 24-hexadecimal digit string that identifies the migration.

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


## Responses
### 200
OK

#### Body: application/vnd.atlas.2023-01-01+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.

### 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)