The Relational Migrator REST API provides you with programmatic access to Relation Migrator with HTTPS endpoints. The REST API is a Relational Migrator service between your application and your source and destination databases that you can send requests to manage your migration jobs.
You don't need to install any additional extensions or packages to use the Relational Migrator REST API. The functionality is part of the Relational Migrator product. The REST API runs on the same port that you access the application on (either 8278, 8080, or 443).
How the REST API Works
The Relational Migrator REST API runs on the client computer or server that has Relational Migrator installed. By default, Relational Migrator does not expose the API to any remote computers. If you use the default security settings, you must make all calls to the API on the same computer that you are running Relational Migrator on.
If you want to remotely access the REST API, configure the unattended profile by installing Relational Migrator on an
unattended server.
Warning
The REST API does not support authentication. If you enable remote access, users do not need to authenticate to call the API which may cause security vulnerabilities.
When to Use REST API
Use the Relational Migrator REST API when:
You want to use a task scheduler such as cron to run migration jobs on a cadence, such as daily, instead of running them once.
You want to define dynamic table filters within a project to control which data each migration job processes. For example, using a table filter with
WHERE DATEDIFF(CURDATE(), last_modified) <= 1to migrate only recently modified data in each batch.You want to programmatically create Relational Migrator migration jobs dynamically. For example, using connection strings from multiple databases without manually configuring them in the GUI.
You generally prefer scripting your workflows instead of using a GUI.
Note
Migration jobs are non-idempotent by default. If you schedule jobs to run on a cadence, enable idempotency so that each run replaces the documents from the previous run instead of creating duplicate documents. For information about enabling idempotency, see Data Migration.
Learn More
For Relational Migrator REST API endpoints, example requests, and responses, see the Endpoints.