# TiDB Cloud API v1beta

**Canonical:** https://apis.io/apis/tidb/tidb-cloud-api-v1beta/  
**Provider:** Tidb — https://apis.io/providers/tidb/  
**Base URL:** https://api.tidbcloud.com  
**Documentation:** https://docs.pingcap.com/tidbcloud/api/v1beta/

TiDB Cloud API v1beta 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 Project, Cluster, Backup, Import, and Restore. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and rate-limit docs.

The original TiDB Cloud management API, still served at api.tidbcloud.com and still the only surface that exposes projects — projects, clusters, backups, restores and the deprecated import operations. 30 operations, harvested verbatim from PingCAP. Superseded by the v1beta1 APIs, with no published end-of-life date.

## Operations (30)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1beta/clusters/provider/regions` | List the cloud providers, regions and available specifications. |
| GET | `/api/v1beta/projects` | List all accessible projects. |
| POST | `/api/v1beta/projects` | Create a project. |
| GET | `/api/v1beta/projects/{project_id}/aws-cmek` | List AWS Customer-Managed Encryption Keys for a project. |
| POST | `/api/v1beta/projects/{project_id}/aws-cmek` | Configure AWS Customer-Managed Encryption Keys for a project. |
| GET | `/api/v1beta/projects/{project_id}/clusters` | List all clusters in a project. |
| POST | `/api/v1beta/projects/{project_id}/clusters` | Create a cluster. |
| GET | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}` | Get a cluster by ID. |
| DELETE | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}` | Delete a cluster. |
| PATCH | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}` | Modify a TiDB Cloud Dedicated cluster. |
| GET | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups` | List all backups for a cluster. |
| POST | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups` | Create a backup for a cluster. |
| GET | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups/{backup_id}` | Get a backup for a cluster. |
| DELETE | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/backups/{backup_id}` | Delete a backup for a cluster. |
| GET | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports` | List all import tasks for a cluster. |
| POST | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports` | Create an import task. |
| POST | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/preview` | Preview data before starting an import task. |
| GET | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/role_info` | Retrieve the role information for import tasks on a cluster. |
| POST | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/upload_file` | Upload a local file for an import task. |
| GET | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/{import_id}` | Get an import task. |
| PATCH | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/imports/{import_id}` | Update an import task. |
| GET | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/private_endpoint_service` | Retrieve the private endpoint service information for a cluster. |
| POST | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/private_endpoint_service` | Create a private endpoint service for a cluster. |
| GET | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/private_endpoints` | List all private endpoints for a cluster. |
| POST | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/private_endpoints` | Create a private endpoint for a cluster. |
| DELETE | `/api/v1beta/projects/{project_id}/clusters/{cluster_id}/private_endpoints/{endpoint_id}` | Delete a private endpoint for a cluster. |
| GET | `/api/v1beta/projects/{project_id}/private_endpoints` | List all private endpoints in a project. |
| GET | `/api/v1beta/projects/{project_id}/restores` | List the restore tasks in a project. |
| POST | `/api/v1beta/projects/{project_id}/restores` | Create a restore task. |
| GET | `/api/v1beta/projects/{project_id}/restores/{restore_id}` | Get a restore task. |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/openapi/_original/tidb-cloud-v1beta-openapi-original.json
- **OpenAPI** — https://docs-download.pingcap.com/api/tidbcloud-oas.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/overlays/tidb-v1beta-overlay.yaml
- **APIReference** — https://docs.pingcap.com/tidbcloud/api/v1beta/
- **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

Project, Cluster, Backup, Import, Restore

---

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