TiKV Configuration API

openapi: 3.1.0
info:
  title: TiKV HTTP Management Configuration 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: Configuration
  description: TiKV node configuration management
paths:
  /config:
    get:
      operationId: getConfig
      summary: Get Configuration
      description: Returns the current runtime configuration of the TiKV node. Supports optional section and key filtering.
      tags:
      - Configuration
      parameters:
      - name: section
        in: query
        required: false
        schema:
          type: string
        description: Filter by configuration section (e.g., storage, raftstore)
      - name: key
        in: query
        required: false
        schema:
          type: string
        description: Filter by specific configuration key within a section
      responses:
        '200':
          description: Configuration returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TiKVConfig'
    post:
      operationId: updateConfig
      summary: Update Configuration
      description: Updates runtime configuration of the TiKV node. Only certain configuration keys support online updates.
      tags:
      - Configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              description: Key-value pairs of configuration to update
      responses:
        '200':
          description: Configuration updated successfully
        '400':
          description: Invalid configuration
components:
  schemas:
    TiKVConfig:
      type: object
      properties:
        storage:
          type: object
          description: Storage engine configuration
        raftstore:
          type: object
          description: Raft store configuration
        coprocessor:
          type: object
          description: Coprocessor configuration
        server:
          type: object
          description: Server configuration
        rocksdb:
          type: object
          description: RocksDB configuration
        pd:
          type: object
          description: Placement Driver connection configuration