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 Regions API

Operations for listing available cloud regions and node specifications.

Documentation Provider Profile APIs.io OpenAPI GitHub

tidb Regions 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 Regions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

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

Requests are made against 4 base URLs: https://dedicated.tidbapi.com/v1beta1, https://iam.tidbapi.com/v1beta1, https://billing.tidbapi.com/v1beta1, http://localhost:10080.

8 operations 8 paths 15 schemas 7 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.tidbcloud.com
Authentication
HTTP Digest
Resource Areas
1

Authentication & Security 1

tidb Regions API declares 1 security scheme for authenticating requests. It uses HTTP digest authentication (digestAuth).

  • 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 8 paths, the API surfaces 8 operations — 7 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Regions 8

Operations for listing available cloud regions and node specifications.

GET
/regions
List regions
listRegions 2 params → 200401
GET
/regions/{regionId}
Get a region
getRegion 1 param → 200401404
GET
/regions/{regionId}/nodeSpecs
List node specifications
listNodeSpecs 3 params → 200401404
GET
/regions/meta
List all regions metadata
listRegionsMeta → 200
GET
/regions/hot
Get hot regions
getHotRegions → 200
GET
/regions/{regionID}
Get a region
getRegionByID 1 param → 200404
GET
/tables/{db}/{table}/regions
Get table regions
getTableRegions 2 params → 200404
POST
/tables/{db}/{table}/scatter
Scatter table regions
scatterTableRegions 2 params → 200404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are RegionFrame (7 properties), RegionDetail (5 properties), NodeSpec (4 properties), RegionInfo (4 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Standard error response returned when an API request fails.
4 properties
NodeSpec
object
A node specification option for a cluster component.
4 properties
Region
object
A cloud region where TiDB Cloud Dedicated clusters can be deployed.
3 properties
ListRegionsResponse
object
Paginated list of available regions.
2 properties
ListNodeSpecsResponse
object
Paginated list of node specifications for a region.
2 properties
HotRegion
object
A hot region with throughput statistics.
2 properties
TableRegions
object
Region distribution information for a TiDB table.
4 properties
RegionFrame
object
A mapping from a TiKV region to a TiDB table or index.
7 properties
RegionMeta
object
Metadata about a TiKV region.
4 properties
RegionPeer
object
A peer replica of a TiKV region.
2 properties
HotRegions
object
Hot read and write region data across all TiKV stores.
2 properties
RegionInfo
object
Detailed information about a specific TiKV region.
4 properties
HotRegionStore
object
Hot region data for a specific TiKV store.
2 properties
IndexRegions
object
Region information for a specific table index.
3 properties
RegionDetail
object
Details about a specific TiKV region hosting table or index data.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tidb-regions-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 Clusters 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
#Regions
← Back to T APIs
API Details
ID
tidb:tidb-regions-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-regions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/tidb-regions-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 Regions 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.