Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.92 KB

api-overview.md

File metadata and controls

28 lines (21 loc) · 1.92 KB
Raw
title summary
TiDB Cloud API Overview
Learn about what is TiDB Cloud API, its features, and how to use API to manage your TiDB Cloud clusters.

TiDB Cloud API Overview Beta

Note:

TiDB Cloud API is in 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: