Data Migration API Overview

TiDB Data Migration (DM) is an integrated data migration task management platform that supports full data migration and incremental data replication from MySQL-compatible databases (such as MySQL, MariaDB, and Aurora MySQL) into TiDB.

DM provides an OpenAPI for querying and operating the DM cluster, similar to the dmctl tool.

You can use DM APIs to perform the following maintenance operations on the DM cluster:

• Cluster management: Get information about or stop DM-master and DM-worker nodes.
• Data source management: Create, update, delete, enable, or disable data sources, manage relay-log features, and change the bindings between your data source and DM-workers.
• Replication task management: Create, update, delete, start, or stop replication tasks; manage schemas and migration rules.

For more information about each API, including request parameters, response examples, and usage instructions, see Maintain DM Clusters Using OpenAPI.