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

tidb Schema API

Endpoints for retrieving database and table schema information from the TiDB information schema.

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

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

Requests are made against a single base URL, http://localhost:10080.

4 operations 4 paths 6 schemas 4 GET

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
Terms of Service
Resource Areas
1

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Schema 4

Endpoints for retrieving database and table schema information from the TiDB information schema.

GET
/schema
Get all database schemas
getAllSchemas → 200
GET
/schema/{db}
Get database schema
getDatabaseSchema 2 params → 200404
GET
/schema/{db}/{table}
Get table schema
getTableSchema 3 params → 200404
GET
/db-table/{tableID}
Get table info by table ID
getTableByID 1 param → 200404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TableSchema (6 properties), IndexInfo (6 properties), ColumnInfo (3 properties), DatabaseSchema (3 properties). Each schema is shown below with its type and property counts.

DatabaseSchema
object
Schema information for a TiDB database.
3 properties
IndexInfo
object
An index definition on a TiDB table.
6 properties
ColumnInfo
object
A column definition within a TiDB table schema.
3 properties
TableByIDResponse
object
Database and table information looked up by table ID.
2 properties
TableSchema
object
Schema information for a TiDB table.
6 properties
CIStr
object
A case-insensitive string pair used in TiDB schema objects.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tidb-schema-api-openapi.yml Raw ↑

Other APIs Tidb publishes across the network.

tidb API Keys API
tidb Audit Logs API
tidb Billing API
tidb Chat2Data API
tidb Clusters API
tidb Data App API Keys API
tidb Data Apps API
tidb Data Sources API
tidb Data Summaries API
tidb DDL API
tidb Deployments API
tidb Diagnostics API
Where this information came from

This is an independent, third-party profile of tidb Schema 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.