PingCAP

PingCAP Cluster API

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

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 32

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 #

Documentation

📖
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/
📖
Documentation
https://docs.pingcap.com/tidb/stable/dm-open-api/
📖
Documentation
https://ossinsight.io/docs/api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/pingcap/openapi/pingcap-cluster-api-openapi.yml

Other Resources

🔗
Sandbox
https://zero.tidbcloud.com/
🔗
SourceCode
https://github.com/pingcap/tiflow/blob/master/dm/openapi/spec/dm.yaml
🔗
SourceCode
https://github.com/pingcap/ossinsight

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/pingcap:pingcap-cluster-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

pingcap-cluster-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pingcap Cluster API
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Cluster across 4 of this provider''s published API definitions: pingcap-tidb-cloud-dedicated-v1beta1-openapi-original.json, pingcap-tidb-cloud-starter-essential-v1beta1-openapi-original.json, pingcap-tidb-cloud-v1beta-openapi-original.json, pingcap-tidb-dm-openapi-original.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dedicated.tidbapi.com/v1beta1
- url: https://serverless.tidbapi.com/v1beta1
- url: https://api.tidbcloud.com
- url: https://you.domain.com/
tags:


# --- truncated at 32 KB (271 KB total) ---
# Full source: https://artifacts.apis.io/pingcap/openapi/pingcap-cluster-api-openapi.yml