# TiDB Cloud Dedicated API

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

TiDB Cloud Dedicated 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, Region, Private Endpoint Connection, Import, and Integration. 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 Dedicated clusters — clusters, TiDB node groups, regions and node specs, private endpoint connections, data imports, observability integrations and CDC changefeeds. 36 operations, harvested verbatim from PingCAP.

## Operations (36)

| Method | Path | Summary |
|---|---|---|
| GET | `/clusters` | List clusters |
| POST | `/clusters` | Create a cluster |
| GET | `/clusters/{clusterId}` | Get a cluster |
| DELETE | `/clusters/{clusterId}` | Delete a cluster |
| PATCH | `/clusters/{clusterId}` | Update a cluster |
| POST | `/clusters/{clusterId}:pauseCluster` | Pause a cluster |
| POST | `/clusters/{clusterId}:resumeCluster` | Resume a cluster |
| POST | `/clusters/{clusterId}:resetRootPassword` | Reset the root password of a cluster |
| GET | `/clusters:showNodeQuota` | List node quotas for your organization |
| GET | `/clusters/{clusterId}/logRedactionPolicy` | Get log redaction policy |
| GET | `/regions` | List regions |
| GET | `/regions/{regionId}` | Get a region |
| GET | `/regions:showCloudProviders` | List cloud providers |
| GET | `/regions/{regionId}/nodeSpecs` | List node specs |
| GET | `/regions/{regionId}/componentTypes/{componentType}/nodeSpecs/{nodeSpecKey}` | Get a node spec |
| GET | `/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateLinkService` | Get private link service for a TiDB node group |
| GET | `/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections` | List private endpoint connections |
| POST | `/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections` | Create a private endpoint connection |
| GET | `/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections/{privateEndpointConnectionId}` | Get a private endpoint connection |
| DELETE | `/clusters/{clusterId}/tidbNodeGroups/{tidbNodeGroupId}/privateEndpointConnections/{privateEndpointConnectionId}` | Delete a private endpoint connection |
| GET | `/clusters/{clusterId}/imports` | List import tasks |
| POST | `/clusters/{clusterId}/imports` | Create an import task |
| GET | `/clusters/{clusterId}/imports/{importId}` | Get an import task |
| POST | `/clusters/{clusterId}/imports/{importId}:cancel` | Cancel an import task |
| GET | `/clusters/{clusterId}/integrations` | List integrations |
| POST | `/clusters/{clusterId}/integrations` | Create an integration |
| DELETE | `/clusters/{clusterId}/integrations/{id}` | Delete an integration |
| GET | `/changefeedRCUs` | List changefeed RCU options |
| 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` | Update a changefeed downstream config |
| POST | `/changefeeds/{changefeedId}:pause` | Pause a changefeed |
| POST | `/changefeeds/{changefeedId}:resume` | Resume a changefeed |
| POST | `/changefeeds/{changefeedId}:scale` | Scale a changefeed |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/openapi/_original/tidb-cloud-dedicated-v1beta1-openapi-original.json
- **OpenAPI** — https://docs-download.pingcap.com/api/tidbcloud-oas-v1beta1-dedicated.swagger.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/tidb/refs/heads/main/overlays/tidb-dedicated-overlay.yaml
- **APIReference** — https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated/
- **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, Region, Private Endpoint Connection, Import, Integration, Changefeed

---

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