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
Tidb

tidb Clusters API

Operations for creating, listing, updating, and deleting TiDB Cloud Dedicated clusters.

Documentation Provider Profile APIs.io OpenAPI GitHub

tidb Clusters API is one of 23 APIs that Tidb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 8 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version v1beta1.

Requests are made against 3 base URLs: https://dedicated.tidbapi.com/v1beta1, https://iam.tidbapi.com/v1beta1, https://billing.tidbapi.com/v1beta1.

8 operations 5 paths 10 schemas 1 DELETE2 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1beta1
Base URL
https://api.tidbcloud.com
Authentication
HTTP Digest
Contact
TiDB Cloud Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

tidb Clusters API declares 1 security scheme for authenticating requests. It uses HTTP digest authentication (digestAuth). By default, every request must be authenticated.

  • digestAuth — HTTP Digest Authentication using a TiDB Cloud API public key as the username and private key as the password. Keys are generated in the TiDB Cloud console unde…

Paths & Operations 8

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

Clusters 8

Operations for creating, listing, updating, and deleting TiDB Cloud Dedicated clusters.

GET
/clusters
List clusters
listClusters 4 params → 200401429
POST
/clusters
Create a cluster
createCluster 1 param body → 200400401429
GET
/clusters/{clusterId}
Get a cluster
getCluster 1 param → 200401404
PATCH
/clusters/{clusterId}
Update a cluster
updateCluster 1 param body → 200400401404
DELETE
/clusters/{clusterId}
Delete a cluster
deleteCluster 1 param → 200401404
POST
/clusters/{clusterId}:pauseCluster
Pause a cluster
pauseCluster 1 param → 200400401404
POST
/clusters/{clusterId}:resumeCluster
Resume a cluster
resumeCluster 1 param → 200400401404
POST
/clusters/{clusterId}:resetRootPassword
Reset root password
resetClusterRootPassword 1 param body → 200400401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Cluster (11 properties), CreateClusterRequest (7 properties), ErrorResponse (4 properties), ConnectionStrings (4 properties). Each schema is shown below with its type and property counts.

Cluster
object
A TiDB Cloud Dedicated cluster resource.
11 properties
ListClustersResponse
object
Paginated list of TiDB Cloud clusters.
2 properties
ConnectionString
object
A specific type of connection string for accessing the cluster.
2 properties
ErrorResponse
object
Standard error response returned when an API request fails.
4 properties
StorageComponentSpec
object
Specification for a TiKV or TiFlash storage node group.
3 properties
ConnectionStrings
object
Connection string information for connecting to the cluster.
4 properties
ClusterComponents
object
The component configuration for a TiDB Cloud cluster.
3 properties
ComponentSpec
object
Specification for a stateless TiDB compute node group.
2 properties
CreateClusterRequest
object
Request body for creating a new TiDB Cloud Dedicated cluster.
7 properties 4 required
UpdateClusterRequest
object
Request body for updating a TiDB Cloud Dedicated cluster configuration.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tidb-clusters-api-openapi.yml Raw ↑

Other APIs Tidb publishes across the network.

tidb API Keys API
AE Profile APIs.io
tidb Audit Logs API
AE Profile APIs.io
tidb Billing API
AE Profile APIs.io
tidb Chat2Data API
AE Profile APIs.io
tidb Data App API Keys API
AE Profile APIs.io
tidb Data Apps API
AE Profile APIs.io
tidb Data Sources API
AE Profile APIs.io
tidb Data Summaries API
AE Profile APIs.io
tidb DDL API
AE Profile APIs.io
tidb Deployments API
AE Profile APIs.io
tidb Diagnostics API
AE Profile APIs.io
tidb Endpoints API
AE Profile APIs.io
#Cluster
← Back to T APIs
API Details
ID
tidb:tidb-clusters-api
Base URL
https://api.tidbcloud.com
Docs
https://docs.pingcap.com/tidbcloud/api-overview/
Provider
Tidb
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=tidb-clusters-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/tidb-clusters-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 tidb Clusters 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.