# PingCAP Cluster API

**Canonical:** https://apis.io/apis/pingcap/pingcap-cluster-api/  
**Provider:** PingCAP — https://apis.io/providers/pingcap/  
**Base URL:** https://serverless.tidbapi.com/v1beta1  
**Documentation:** https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/

PingCAP Cluster API is one of 32 APIs that [PingCAP](https://apis.io/providers/pingcap/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

Create, get, update, delete, pause, resume, reset the root password, and list node quotas of a cluster.

## Operations (32)

| 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 |
| PATCH | `/clusters/{cluster.clusterId}` | Update a TiDB Cloud Starter or Essential instance |
| GET | `/regions` | List available regions for an organization |
| GET | `/api/v1beta/clusters/provider/regions` | List the cloud providers, regions and available specifications. |
| 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}/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/v1/cluster/info` | get cluster info such as cluster id |
| PUT | `/api/v1/cluster/info` | update cluster info. |
| GET | `/api/v1/cluster/masters` | get cluster master node list |
| DELETE | `/api/v1/cluster/masters/{master-name}` | offline master node |
| GET | `/api/v1/cluster/workers` | get cluster worker node list |
| DELETE | `/api/v1/cluster/workers/{worker-name}` | offline worker node |

## Machine-readable artifacts (19)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/pingcap/refs/heads/main/openapi/pingcap-cluster-api-openapi.yml
- **Documentation** — https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/
- **APIReference** — https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/
- **Documentation** — https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated/
- **APIReference** — https://docs.pingcap.com/tidbcloud/api/v1beta1/dedicated/
- **Documentation** — https://docs.pingcap.com/tidbcloud/api/v1beta1/iam/
- **APIReference** — https://docs.pingcap.com/tidbcloud/api/v1beta1/iam/
- **Documentation** — https://docs.pingcap.com/tidbcloud/api/v1beta1/billing/
- **APIReference** — https://docs.pingcap.com/tidbcloud/api/v1beta1/billing/
- **Documentation** — https://docs.pingcap.com/tidbcloud/api/v1beta1/dataservice/
- **APIReference** — https://docs.pingcap.com/tidbcloud/api/v1beta1/dataservice/
- **Documentation** — https://docs.pingcap.com/tidbcloud/api/v1beta/
- **APIReference** — https://docs.pingcap.com/tidbcloud/api/v1beta/
- **Documentation** — https://zero.tidbcloud.com/
- **Sandbox** — https://zero.tidbcloud.com/
- **Documentation** — https://docs.pingcap.com/tidb/stable/dm-open-api/
- **SourceCode** — https://github.com/pingcap/tiflow/blob/master/dm/openapi/spec/dm.yaml
- **Documentation** — https://ossinsight.io/docs/api
- **SourceCode** — https://github.com/pingcap/ossinsight

## Other PingCAP APIs (12)

- [TiDB MCP Server](https://apis.io/apis/pingcap/tidb-mcp-server/)
- [PingCAP API Key API](https://apis.io/apis/pingcap/pingcap-api-key-api/)
- [PingCAP Audit Log API](https://apis.io/apis/pingcap/pingcap-audit-log-api/)
- [PingCAP Backup API](https://apis.io/apis/pingcap/pingcap-backup-api/)
- [PingCAP Billing API](https://apis.io/apis/pingcap/pingcap-billing-api/)
- [PingCAP Branch API](https://apis.io/apis/pingcap/pingcap-branch-api/)
- [PingCAP Changefeed API](https://apis.io/apis/pingcap/pingcap-changefeed-api/)
- [PingCAP Chat2 Query API](https://apis.io/apis/pingcap/pingcap-chat2query-api/)
- [PingCAP Collections API](https://apis.io/apis/pingcap/pingcap-collections-api/)
- [PingCAP Data API Key API](https://apis.io/apis/pingcap/pingcap-data-api-key-api/)
- [PingCAP Data App API](https://apis.io/apis/pingcap/pingcap-data-app-api/)
- [PingCAP Data Source API](https://apis.io/apis/pingcap/pingcap-data-source-api/)

## Tags

Cluster

---

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