TiDBTiDB Docs Dash 2024

Jan 9 - Jan 12 (UTC)
Join us to improve docs and win a prize!
Sign InTry Free

TiDB Cloud API Overview Beta

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, and Billings.

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.

To start using TiDB Cloud API, refer to the following resources in TiDB Cloud API Documentation:

Was this page helpful?

Download PDFRequest docs changesAsk questions on Discord
Playground
New
One-stop & interactive experience of TiDB's capabilities WITHOUT registration.
Products
TiDB
TiDB Dedicated
TiDB Serverless
Pricing
Get Demo
Get Started
© 2024 PingCAP. All Rights Reserved.
Privacy Policy.