Return One Specific Migration Job
On this page
Return the status of a current push live migration job and a list of all configured migrations hosts. Each push live migration job uses one migration host.
Required Roles
Your API Key must have the Organization Member role to
successfully call this resource.
Request
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
GET /groups/{groupId}/liveMigrations/{liveMigrationId}
Request Path Parameters
Name | Type | Necessity | Description |
|---|---|---|---|
groupId | string | Required | Unique 24-hexadecimal digit string that identifies your project. |
liveMigrationId | string | Required | Unique 24-hexadecimal digit string that identifies the live
migration job. |
Request Query Parameters
This endpoint might use any of the HTTP request query parameters available to all Atlas Administration API resources. All of these are optional.
Name | Type | Necessity | Description | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a
prettyprint format. | false | ||||||
envelope | boolean | Optional | Flag indicating if Atlas should wrap the response in a JSON envelope. This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes:
| false |
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
Name | Type | Description |
|---|---|---|
_id | string | Unique 24-hexadecimal digit string that identifies the migration. |
status | string | State of the migration when you submitted this request. Returns one of the following values:
|
migrationHosts | array | List of hosts running the MongoDB Agent that can transfer your
MongoDB data from the source (Cloud Manager or Ops Manager) to destination
(Atlas) deployments. Each live migration process uses its
own dedicated migration host. |
readyForCutover | boolean | Flag that indicates whether the live migration process is ready
to start the cutover process. |
Example Request
curl --user '{USERNAME}:{APIKEY}' --digest \ --header 'Content-Type: application/json' \ --include \ --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true'
Example Response
Response Header
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes}
Response Body
{ "_id": "7e68e12770616e75e6df43d0", "migrationHosts": "vm001.example.com", "readyForCutover": true, "status": "NEW" }