# TiDB Cloud Premium API

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

TiDB Cloud Premium 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 TiDB Cloud Premium Instance, Backup, Region, and Changefeed. 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 TiDB Cloud Premium, the v1beta2 API — Premium instance lifecycle and configuration, root passwords, CA certificates, cloud provider information, backups and backup-based restore, regions and changefeeds. 25 operations, harvested verbatim from PingCAP.

## Operations (25)

| Method | Path | Summary |
|---|---|---|
| GET | `/tidbs` | List TiDB Cloud Premium instances |
| POST | `/tidbs` | Create a TiDB Cloud Premium instance |
| GET | `/tidbs/{tidbId}` | Get a TiDB Cloud Premium instance |
| DELETE | `/tidbs/{tidbId}` | Delete a TiDB Cloud Premium instance |
| PATCH | `/tidbs/{tidb.tidbId}` | Update a TiDB Cloud Premium instance |
| POST | `/tidbs/{tidbId}:resetRootPassword` | Reset the root password of a TiDB Cloud Premium instance |
| GET | `/tidbs/{tidbId}/cloudProviderInfo` | Get cloud provider information for a TiDB Cloud Premium instance |
| GET | `/tidbs/{tidbId}/backups` | List backups for a TiDB Cloud Premium instance |
| POST | `/tidbs/{tidbId}/backups` | Create a backup for a TiDB Cloud Premium instance |
| DELETE | `/tidbs/{tidbId}/backups/{backupId}` | Delete a backup for a TiDB Cloud Premium instance |
| POST | `/tidbs:restore` | Restore a TiDB Cloud Premium instance from a backup |
| GET | `/tidbs/{tidbId}:getRestoreStatus` | Get the restore status for a TiDB Cloud Premium instance |
| GET | `/tidbs/{tidbId}/caCertificateUrl` | Get the CA certificate download URL for a TiDB Cloud Premium instance |
| GET | `/backups` | List backups |
| DELETE | `/backups/{backupId}` | Delete a backup |
| GET | `/regions` | List regions |
| GET | `/changefeeds` | List changefeeds |
| POST | `/changefeeds` | Create a changefeed |
| GET | `/changefeeds/{changefeedId}` | Get a changefeed |
| DELETE | `/changefeeds/{changefeedId}` | Delete a changefeed |
| POST | `/changefeeds/{changefeedId}:editDownstreamConfig` | Edit changefeed downstream configuration |
| POST | `/changefeeds/{changefeedId}:pause` | Pause a changefeed |
| POST | `/changefeeds/{changefeedId}:resume` | Resume a changefeed |
| POST | `/changefeeds/{changefeedId}:scale` | Scale a changefeed |
| GET | `/changefeeds:listCCUs` | List changefeed CCU options |

## Machine-readable artifacts (8)

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

TiDB Cloud Premium Instance, Backup, Region, Changefeed

---

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