TiDB Cloud API v1beta1 Overview

The TiDB Cloud API v1beta1 is a RESTful API that gives you programmatic access to manage administrative objects within TiDB Cloud. Through this API, you can automatically and efficiently manage cluster-level resources (such as clusters and branches) and organization- or project-level resources (such as billing, Data Service, and IAM).

Currently, you can use the following v1beta1 APIs to manage the resources in TiDB Cloud:

• Cluster-level resources:
  • TiDB Cloud Starter or Essential Cluster: manage clusters, branches, data export tasks, and data import tasks for TiDB Cloud Starter or Essential clusters.
  • TiDB Cloud Dedicated Cluster: manage clusters, regions, private endpoint connections, and data import tasks for TiDB Cloud Dedicated clusters.
• Organization or project-level resources:
  • Billing: manage billing for TiDB Cloud clusters.
  • Data Service: manage resources in the Data Service for TiDB Cloud clusters.
  • IAM: manage API keys for TiDB Cloud clusters.
  • MSP (Deprecated)