> For the complete documentation index, see [llms.txt](https://www.mongodb.com/docs/api/doc/mongodb-relational-migrator-rest-api/llms.txt)

# Post a new migration job

> POST /jobs
> 
> Post a new migration job



## Servers
- http://127.0.0.1:8278/api/v1: http://127.0.0.1:8278/api/v1



## Parameters



### Body: application/json (object)

- **projectId** (string)

- **jdbcConnectionDetails** (object)

- **mongodbConnectionDetails** (object)

- **options** (object)

- **verification** (object)

- **relationalTableFilters** (object)
  An object where each key represents a schema name. Each schema contains tables you can apply table filters on.

- **collectionFilters** (object)
  Include or exclude collections for this migration.
  - include only: Only collections matching the specified include filter will be migrated.
  - exclude only: All collections will be migrated, except those matching the exclude filter.
  - include and exclude: Migrate collections that match the include filter, excluding those that also match the exclude filter. 
  - No filters: All collections will be migrated.



## Responses
### 200
OK

#### Body: application/json (object)
- **id** (string)

- **projectId** (string)

- **status** (string)

- **cdcStatus** (string)

- **verificationJobId** (string)

- **options** (object)

- **jdbcConnectionString** (string)

- **mongoDbConnectionString** (string)

- **submittedAt** (string(date-time))

- **statistics** (object)

- **cdcStatistics** (object)

- **jmxConnectivity** (object)
  Connectivity of the JMX statistics scrape (kafka-connect deployment profile only). Indicates
  whether the migrator is successfully scraping statistics over JMX and when it last did so, so a
  misconfigured/unreachable JMX endpoint or a crashed connect task is visible in the UI. Absent for
  deployments that do not read statistics over JMX.

- **connectorStatus** (object)
  Runtime status of the Kafka Connect connectors backing this migration job (kafka-connect /
  confluent deployment profiles only), reflecting the actual state reported by Kafka Connect rather
  than assuming success at submission time. Lets the UI show which specific connector/task has an
  issue instead of a job that looks healthy while a connector is FAILED. Absent for deployments not
  backed by Kafka Connect.

- **failureError** (object)

- **metadata** (object)

- **relationalTableFilters** (object)
  An object where each key represents a schema name. Each schema contains tables you can apply table filters on.

- **collectionFilters** (object)
  Include or exclude collections for this migration.
  - include only: Only collections matching the specified include filter will be migrated.
  - exclude only: All collections will be migrated, except those matching the exclude filter.
  - include and exclude: Migrate collections that match the include filter, excluding those that also match the exclude filter. 
  - No filters: All collections will be migrated.


### 400
Bad request

#### Body: application/json (object)
- **errorType** (string)
  An error category identifying what kind of error occurred.

- **message** (string)
  A human-readable explanation of what went wrong.

- **timestamp** (string(date-time))
  The date and time the error occurred.

- **issues** (array[object])
  The individual problems that make up this error.


### 409
Conflict

#### Body: application/json (object)
- **errorType** (string)
  An error category identifying what kind of error occurred.

- **message** (string)
  A human-readable explanation of what went wrong.

- **timestamp** (string(date-time))
  The date and time the error occurred.

- **issues** (array[object])
  The individual problems that make up this error.


### 422
Unprocessable Entity

#### Body: application/json (object)
- **errorType** (string)
  An error category identifying what kind of error occurred.

- **message** (string)
  A human-readable explanation of what went wrong.

- **timestamp** (string(date-time))
  The date and time the error occurred.

- **issues** (array[object])
  The individual problems that make up this error.


### 500
Internal Server Error

#### Body: application/json (object)
- **errorType** (string)
  An error category identifying what kind of error occurred.

- **message** (string)
  A human-readable explanation of what went wrong.

- **timestamp** (string(date-time))
  The date and time the error occurred.

- **issues** (array[object])
  The individual problems that make up this error.



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