openapi: 3.1.0
info:
  title: TiKV HTTP Management Configuration Status API
  description: TiKV exposes an HTTP management API on each node for status monitoring, configuration management, and Prometheus metrics. The default port is 20160 for TiKV nodes and 2379 for PD (Placement Driver) nodes.
  version: '7.1'
  contact:
    name: TiKV Community
    url: https://tikv.org/
  license:
    name: Apache 2.0
    url: https://github.com/tikv/tikv/blob/master/LICENSE
servers:
- url: http://localhost:20160
  description: TiKV node HTTP API (default port)
tags:
- name: Status
  description: Node status and health
paths:
  /status:
    get:
      operationId: getStatus
      summary: Get Node Status
      description: Returns the current status of the TiKV node including version information, Git hash, and whether the node is ready. Also used as a keepalive endpoint.
      tags:
      - Status
      responses:
        '200':
          description: Node status returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeStatus'
components:
  schemas:
    NodeStatus:
      type: object
      properties:
        start_time_s:
          type: integer
          description: Unix timestamp when TiKV started
        uptime:
          type: string
          description: Human-readable uptime duration
        version:
          type: string
          description: TiKV version string
        git_hash:
          type: string
          description: Git commit hash
        address:
          type: string
          description: Node listen address
        status:
          type: string
          description: Node status (ok, etc.)