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 (PREVIEW)
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.
Manage TiDB Cloud Essential instances (running TiDB v8.5.3 or earlier), TiDB Cloud Starter instances, and TiDB Cloud Dedicated clusters, as well as billing, Data Service, and IAM resources.
Manage projects, clusters, backups, imports, and restores for TiDB Cloud Dedicated.
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.