TiDB Cloud API Overview (Beta)

3 Contributors

The TiDB Cloud API is a REST interface that provides you with programmatic access to manage administrative objects within TiDB Cloud. Through this API, you can automatically and efficiently manage resources such as Projects, Clusters, Backups, Restores, Imports, Billings, and resources in the Data Service.

The API has the following features:

• JSON entities. All entities are expressed in JSON.
• HTTPS-only. You can only access the API via HTTPS, ensuring all the data sent over the network is encrypted with TLS.
• Key-based access and digest authentication. Before you access TiDB Cloud API, you must generate an API key, refer to API Key Management. All requests are authenticated through HTTP Digest Authentication, ensuring the API key is never sent over the network.

The TiDB Cloud API is available in two versions:

• v1beta1
  • 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)
• v1beta
  • Project
  • Cluster
  • Backup
  • Import (Deprecated)
  • Restore