# TiDB Cloud Starter and Essential API

**Canonical:** https://apis.io/apis/tidb/tidb-cloud-starter-essential-api/  
**Provider:** Tidb — https://apis.io/providers/tidb/  
**Base URL:** https://serverless.tidbapi.com/v1beta1  
**Documentation:** https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/

TiDB Cloud Starter and Essential API is one of 31 APIs that [Tidb](https://apis.io/providers/tidb/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Cluster, Branch, Export, and Import. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and rate-limit docs.

The published Swagger 2.0 contract for managing TiDB Cloud Starter and Essential instances — instances, data branches, export tasks and import tasks, plus the region list. 20 operations, harvested verbatim from PingCAP.

## Operations (20)

| Method | Path | Summary |
|---|---|---|
| GET | `/clusters` | List TiDB Cloud Starter and Essential instances |
| POST | `/clusters` | Create a new TiDB Cloud Starter or Essential instance |
| GET | `/clusters/{clusterId}` | Get details of a TiDB Cloud Starter or Essential instance |
| DELETE | `/clusters/{clusterId}` | Delete a TiDB Cloud Starter or Essential instance |
| PATCH | `/clusters/{cluster.clusterId}` | Update a TiDB Cloud Starter or Essential instance |
| GET | `/regions` | List available regions for an organization |
| GET | `/clusters/{clusterId}/branches` | List branches |
| POST | `/clusters/{clusterId}/branches` | Create a branch |
| GET | `/clusters/{clusterId}/branches/{branchId}` | Get details of a branch |
| DELETE | `/clusters/{clusterId}/branches/{branchId}` | Delete a branch |
| POST | `/clusters/{clusterId}/branches/{branchId}:reset` | Reset a branch |
| GET | `/clusters/{clusterId}/exports` | List export tasks for a TiDB Cloud Starter or Essential instance |
| POST | `/clusters/{clusterId}/exports` | Create an export task |
| GET | `/clusters/{clusterId}/exports/{exportId}` | Get details of an export task |
| DELETE | `/clusters/{clusterId}/exports/{exportId}` | Delete an export task |
| POST | `/clusters/{clusterId}/exports/{exportId}:cancel` | Cancel an export task |
| GET | `/clusters/{clusterId}/imports` | List import tasks for a TiDB Cloud Starter or Essential instance |
| POST | `/clusters/{clusterId}/imports` | Create an import task |
| GET | `/clusters/{clusterId}/imports/{id}` | Get details of an import task |
| POST | `/clusters/{clusterId}/imports/{id}:cancel` | Cancel an import task |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/openapi/_original/tidb-cloud-starter-essential-v1beta1-openapi-original.json
- **OpenAPI** — https://docs-download.pingcap.com/api/tidbcloud-oas-v1beta1-serverless.swagger.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/overlays/tidb-starter-essential-overlay.yaml
- **APIReference** — https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/
- **Documentation** — https://docs.pingcap.com/tidbcloud/api-overview/
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/authentication/tidb-authentication.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/rate-limits/tidb-rate-limits.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/errors/tidb-problem-types.yml

## Other Tidb APIs (12)

- [tidb API Keys API](https://apis.io/apis/tidb/tidb-api-keys-api/)
- [tidb Audit Logs API](https://apis.io/apis/tidb/tidb-audit-logs-api/)
- [tidb Billing API](https://apis.io/apis/tidb/tidb-billing-api/)
- [tidb Chat2Data API](https://apis.io/apis/tidb/tidb-chat2data-api/)
- [tidb Clusters API](https://apis.io/apis/tidb/tidb-clusters-api/)
- [tidb Data App API Keys API](https://apis.io/apis/tidb/tidb-data-app-api-keys-api/)
- [tidb Data Apps API](https://apis.io/apis/tidb/tidb-data-apps-api/)
- [tidb Data Sources API](https://apis.io/apis/tidb/tidb-data-sources-api/)
- [tidb Data Summaries API](https://apis.io/apis/tidb/tidb-data-summaries-api/)
- [tidb DDL API](https://apis.io/apis/tidb/tidb-ddl-api/)
- [tidb Deployments API](https://apis.io/apis/tidb/tidb-deployments-api/)
- [tidb Diagnostics API](https://apis.io/apis/tidb/tidb-diagnostics-api/)

## Tags

Cluster, Branch, Export, Import

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/tidb/tidb-cloud-starter-essential-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/tidb/.