Skip to content

tidb-cloud-api-overview.md

Latest commit

 

History

History
24 lines (17 loc) · 1.64 KB

tidb-cloud-api-overview.md

File metadata and controls

24 lines (17 loc) · 1.64 KB
title TiDB Cloud API Overview
summary Learn about what TiDB Cloud API is, its features, and how to use the API to manage your TiDB Cloud clusters.
aliases
/tidbcloud/api-overview/

TiDB Cloud API Overview

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, 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 the TiDB Cloud API, you must generate an API key. For more information, see 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: manage TiDB Cloud Starter, Essential, and Dedicated clusters, as well as billing, Data Service, and IAM resources.
  • v1beta: manage projects, clusters, backups, imports, and restores for TiDB Cloud.
⚡