How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
PingCAP

PingCAP Cluster API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

PingCAP Cluster API is one of 32 APIs that PingCAP publishes on the 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.

This API exposes 32 operations across 22 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://you.domain.com/.

32 operations 22 paths 12 schemas 5 DELETE15 GET3 PATCH8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://serverless.tidbapi.com/v1beta1
Resource Areas
1

Paths & Operations 32

Across 22 paths, the API surfaces 32 operations — 5 DELETE, 15 GET, 3 PATCH, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Cluster 32

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

GET
/clusters
List clusters
ClusterService_ListClusters 7 params → 200400401403429500default
POST
/clusters
Create a cluster
ClusterService_CreateCluster 2 params → 200400401403429500default
GET
/clusters/{clusterId}
Get a cluster
ClusterService_GetCluster 1 param → 200400401403429500default
DELETE
/clusters/{clusterId}
Delete a cluster
ClusterService_DeleteCluster 2 params → 200400401403429500default
PATCH
/clusters/{clusterId}
Update a cluster
ClusterService_UpdateCluster 3 params → 200400401403429500default
POST
/clusters/{clusterId}:pauseCluster
Pause a cluster
ClusterService_PauseCluster 1 param → 200400401403429500default
POST
/clusters/{clusterId}:resumeCluster
Resume a cluster
ClusterService_ResumeCluster 1 param → 200400401403429500default
POST
/clusters/{clusterId}:resetRootPassword
Reset the root password of a cluster
ClusterService_ResetRootPassword 2 params → 200400401403429500default
GET
/clusters:showNodeQuota
List node quotas for your organization
ClusterService_ShowNodeQuota → 200400401403429500default
GET
/clusters/{clusterId}/logRedactionPolicy
Get log redaction policy
ClusterService_GetLogRedactionPolicy 1 param → 200400401403429500default
PATCH
/clusters/{cluster.clusterId}
Update a TiDB Cloud Starter or Essential instance
ClusterService_PartialUpdateCluster 2 params → 200400401403429500default
GET
/regions
List available regions for an organization
ClusterService_ListRegions → 200400401403429500default
GET
/api/v1beta/clusters/provider/regions
List the cloud providers, regions and available specifications.
ListProviderRegions → 200400401403404429500default
GET
/api/v1beta/projects/{project_id}/aws-cmek
List AWS Customer-Managed Encryption Keys for a project.
ListAwsCmek 1 param → 200400401403404429500default
POST
/api/v1beta/projects/{project_id}/aws-cmek
Configure AWS Customer-Managed Encryption Keys for a project.
CreateAwsCmek 2 params → 200400401403404429500default
GET
/api/v1beta/projects/{project_id}/clusters
List all clusters in a project.
ListClustersOfProject 3 params → 200400401403404429500default
POST
/api/v1beta/projects/{project_id}/clusters
Create a cluster.
CreateCluster 2 params → 200400401403404429500default
GET
/api/v1beta/projects/{project_id}/clusters/{cluster_id}
Get a cluster by ID.
GetCluster 2 params → 200400401403404429500default
DELETE
/api/v1beta/projects/{project_id}/clusters/{cluster_id}
Delete a cluster.
DeleteCluster 2 params → 200400401403404429500default
PATCH
/api/v1beta/projects/{project_id}/clusters/{cluster_id}
Modify a TiDB Cloud Dedicated cluster.
UpdateCluster 3 params → 200400401403404429500default
GET
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/private_endpoint_service
Retrieve the private endpoint service information for a cluster.
GetPrivateEndpointService 2 params → 200400401403404429500default
POST
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/private_endpoint_service
Create a private endpoint service for a cluster.
CreatePrivateEndpointService 3 params → 200400401403404429500default
GET
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/private_endpoints
List all private endpoints for a cluster.
ListPrivateEndpoints 2 params → 200400401403404429500default
POST
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/private_endpoints
Create a private endpoint for a cluster.
CreatePrivateEndpoint 3 params → 200400401403404429500default
DELETE
/api/v1beta/projects/{project_id}/clusters/{cluster_id}/private_endpoints/{endpoint_id}
Delete a private endpoint for a cluster.
DeletePrivateEndpoint 3 params → 200400401403404429500default
GET
/api/v1beta/projects/{project_id}/private_endpoints
List all private endpoints in a project.
ListPrivateEndpointsOfProject 1 param → 200400401403404429500default
GET
/api/v1/cluster/info
get cluster info such as cluster id
DMAPIGetClusterInfo → 200
PUT
/api/v1/cluster/info
update cluster info.
DMAPIUpdateClusterInfo body → 200
GET
/api/v1/cluster/masters
get cluster master node list
DMAPIGetClusterMasterList → 200400
DELETE
/api/v1/cluster/masters/{master-name}
offline master node
DMAPIOfflineMasterNode 1 param → 204400
GET
/api/v1/cluster/workers
get cluster worker node list
DMAPIGetClusterWorkerList → 200400
DELETE
/api/v1/cluster/workers/{worker-name}
offline worker node
DMAPIOfflineWorkerNode 1 param → 204400

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ClusterTopology (5 properties), ClusterWorker (4 properties), ClusterMaster (4 properties), WorkerTopology (3 properties). Each schema is shown below with its type and property counts.

GrafanaTopology
object
2 properties 2 required
GetClusterInfoResponse
object
2 properties 1 required
PrometheusTopology
object
2 properties 2 required
AlertManagerTopology
object
2 properties 2 required
ClusterWorker
object
4 properties 4 required
GetClusterMasterListResponse
object
2 properties 2 required
WorkerTopology
object
3 properties 3 required
ClusterMaster
object
4 properties 4 required
ClusterTopology
object
5 properties
MasterTopology
object
3 properties 3 required
ErrorWithMessage
object
operation error
2 properties 2 required
GetClusterWorkerListResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pingcap-cluster-api-openapi.yml Raw ↑

Other APIs PingCAP publishes across the network.

TiDB MCP Server
AE Profile APIs.io
PingCAP API Key API
AE Profile APIs.io
PingCAP Audit Log API
AE Profile APIs.io
PingCAP Backup API
AE Profile APIs.io
PingCAP Billing API
AE Profile APIs.io
PingCAP Branch API
AE Profile APIs.io
PingCAP Changefeed API
AE Profile APIs.io
PingCAP Chat2 Query API
AE Profile APIs.io
PingCAP Collections API
AE Profile APIs.io
PingCAP Data API Key API
AE Profile APIs.io
PingCAP Data App API
AE Profile APIs.io
PingCAP Data Source API
AE Profile APIs.io
#Cluster
← Back to P APIs
API Details
ID
pingcap:pingcap-cluster-api
Base URL
https://serverless.tidbapi.com/v1beta1
Docs
https://docs.pingcap.com/tidbcloud/api/v1beta1/serverless/
Provider
PingCAP
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=pingcap-cluster-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pingcap-cluster-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of PingCAP Cluster API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.