TiDB API Overview
TiDB provides various APIs for querying and operating clusters, managing data replication, monitoring system status, and more. This document provides an overview of the available APIs for both TiDB Cloud and TiDB Self-Managed.
TiDB Cloud API (beta)
TiDB Cloud API is a REST interface that provides you with programmatic access to manage administrative objects within TiDB Cloud, such as projects, clusters, backups, restores, imports, billings, and Data Service resources.
| API | Description |
|---|---|
| v1beta1 | Manage TiDB Cloud Starter, Essential, and Dedicated clusters, as well as billing, Data Service, and IAM resources. |
| v1beta | Manage projects, clusters, backups, imports, and restores for TiDB Cloud. |
TiDB Self-Managed API
TiDB Self-Managed provides various APIs for TiDB tools to help you manage cluster components, monitor system status, and control data replication workflows.
| API | Description |
|---|---|
| TiProxy API | Access TiProxy configuration, health status, and monitoring data. |
| Data Migration API | Manage DM-master and DM-worker nodes, data sources, and data replication tasks. |
| Monitoring API | Get TiDB server running status, table storage information, and TiKV cluster details. |
| TiCDC API | Query TiCDC node status and manage replication tasks, including creating, pausing, resuming, and updating operations. |
| TiDB Operator API | Manage TiDB clusters on Kubernetes, including deployment, upgrades, scaling, backup, and failover. |