Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/pingcap/tidb/llms.txt

Use this file to discover all available pages before exploring further.

TiDB exposes an HTTP API on its status port (default 10080). The API requires no authentication by default and covers server status, Prometheus metrics, schema inspection, region metadata, runtime settings, DDL history, and administrative operations.
The status port has no built-in authentication. In production, bind it to localhost or restrict access with a firewall. Never expose port 10080 directly to the public internet.

​
Base URL

http://{tidb-host}:10080
The status port can be changed in tidb.toml: 
[status]
status-port = 10080

​
Quick start

curl http://127.0.0.1:10080/status

{
    "connections": 0,
    "git_hash": "f572e33854e1c0f942f031e9656d0004f99995c6",
    "version": "5.7.25-TiDB-v2.1.0-rc.3-355-gf572e3385-dirty",
    "status": {
        "init_stats_percentage": 100
    }
}

​
API categories

Status and Metrics

Server health, Prometheus metrics, region metadata, schema info, and current settings.

Administration

Update settings, DDL history, GC operations, binlog recovery, profiling, and more.

​
Endpoint reference

CategoryExample endpoints
StatusGET /status, GET /info, GET /info/all
MetricsGET /metrics
RegionsGET /regions/meta, GET /regions/hot, GET /regions/{id}
SchemaGET /schema, GET /schema/{db}, GET /schema/{db}/{table}
TablesGET /tables/{db}/{table}/regions
SettingsGET /settings, POST /settings
DDLGET /ddl/history, POST /ddl/owner/resign
StatsGET /stats/dump/{db}/{table}
DebugGET /debug/zip, GET /debug/pprof/
BinlogGET /binlog/recover
UpgradePOST /upgrade/{op}

Build docs developers (and LLMs) love

Get started for freeTalk to us