MongoDB Relational Migrator REST API
API docs by Redocly

MongoDB Relational Migrator REST API (1.6.0)

Download OpenAPI specification:Download

URL: https://support.mongodb.com/help

OpenAPI specification for MongoDB Relational Migrator tool

Job

Data migration

getJobs

Get all migration jobs

query Parameters
sort
string^\w+,(DESC|ASC)$
Default: "submittedAt,DESC"
Example: sort=submittedAt,DESC

Order in which to retrieve the results

limit
integer
Example: limit=20

Limit the results

type
string (migration-jobs-get-type)
Value: "IN_PROGRESS"
Example: type=IN_PROGRESS

Filter jobs to only of a specific job type

projectId
string (id) ^[A-Za-z0-9]+$

Filter jobs by projectId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createJob

Post a new migration job

Request Body schema: application/json
projectId
required
string
required
object (jdbc-connection-details)
required
object (mongodb-connection-details)
required
object (migration-job-descriptor-options)
required
object (migration-verification)
object (relational-table-filters)

Schema

Responses

Request samples

Content type
application/json
{
  • "projectId": "string",
  • "jdbcConnectionDetails": {
    },
  • "mongodbConnectionDetails": {
    },
  • "options": {
    },
  • "verification": {
    },
  • "relationalTableFilters": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "projectId": "string",
  • "status": "RUNNING",
  • "cdcStatus": "NOT_STARTED",
  • "verificationJobId": "string",
  • "options": {
    },
  • "jdbcConnectionString": "string",
  • "mongoDbConnectionString": "string",
  • "atlasMetadata": {
    },
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "cdcStatistics": {
    },
  • "jobUpdates": [
    ],
  • "failureError": {
    },
  • "migrationErrors": [
    ],
  • "metadata": {
    },
  • "relationalTableFilters": {
    }
}

getJob

Get the status of a migration job by ID

path Parameters
jobId
required
string (id) ^[A-Za-z0-9]+$

Job ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "projectId": "string",
  • "status": "RUNNING",
  • "cdcStatus": "NOT_STARTED",
  • "verificationJobId": "string",
  • "options": {
    },
  • "jdbcConnectionString": "string",
  • "mongoDbConnectionString": "string",
  • "atlasMetadata": {
    },
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "cdcStatistics": {
    },
  • "jobUpdates": [
    ],
  • "failureError": {
    },
  • "migrationErrors": [
    ],
  • "metadata": {
    },
  • "relationalTableFilters": {
    }
}

pauseJob

Pause a running migration job

path Parameters
jobId
required
string (id) ^[A-Za-z0-9]+$

Job ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "projectId": "string",
  • "status": "RUNNING",
  • "cdcStatus": "NOT_STARTED",
  • "verificationJobId": "string",
  • "options": {
    },
  • "jdbcConnectionString": "string",
  • "mongoDbConnectionString": "string",
  • "atlasMetadata": {
    },
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "cdcStatistics": {
    },
  • "jobUpdates": [
    ],
  • "failureError": {
    },
  • "migrationErrors": [
    ],
  • "metadata": {
    },
  • "relationalTableFilters": {
    }
}

resumeJob

Resume a paused migration job

path Parameters
jobId
required
string (id) ^[A-Za-z0-9]+$

Job ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "projectId": "string",
  • "status": "RUNNING",
  • "cdcStatus": "NOT_STARTED",
  • "verificationJobId": "string",
  • "options": {
    },
  • "jdbcConnectionString": "string",
  • "mongoDbConnectionString": "string",
  • "atlasMetadata": {
    },
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "cdcStatistics": {
    },
  • "jobUpdates": [
    ],
  • "failureError": {
    },
  • "migrationErrors": [
    ],
  • "metadata": {
    },
  • "relationalTableFilters": {
    }
}

stopJob

Stop a running migration job

path Parameters
jobId
required
string (id) ^[A-Za-z0-9]+$

Job ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "projectId": "string",
  • "status": "RUNNING",
  • "cdcStatus": "NOT_STARTED",
  • "verificationJobId": "string",
  • "options": {
    },
  • "jdbcConnectionString": "string",
  • "mongoDbConnectionString": "string",
  • "atlasMetadata": {
    },
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "statistics": {
    },
  • "cdcStatistics": {
    },
  • "jobUpdates": [
    ],
  • "failureError": {
    },
  • "migrationErrors": [
    ],
  • "metadata": {
    },
  • "relationalTableFilters": {
    }
}

Project

Captures relational schemas and mappings

getProjects

Get all projects

query Parameters
sort
string^\w+,(DESC|ASC)$
Default: "lastModified,DESC"
Example: sort=lastModified,DESC

Order in which to retrieve the results

Responses

Response samples

Content type
application/json
[
  • {
    }
]