TiKV Debug API

openapi: 3.1.0
info:
  title: TiKV HTTP Management Configuration Debug 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: Debug
  description: Debug and diagnostic endpoints
paths:
  /debug/pprof/profile:
    get:
      operationId: getPprofProfile
      summary: Get CPU Profile
      description: Returns a pprof CPU profile for performance analysis.
      tags:
      - Debug
      parameters:
      - name: seconds
        in: query
        schema:
          type: integer
          default: 10
        description: Duration in seconds to profile
      responses:
        '200':
          description: CPU profile data
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
  /fail/{failpoint}:
    put:
      operationId: setFailpoint
      summary: Set Failpoint
      description: Sets a failpoint for testing and fault injection. Only available when TiKV is compiled with fail-rs support.
      tags:
      - Debug
      parameters:
      - name: failpoint
        in: path
        required: true
        schema:
          type: string
        description: Failpoint name
      requestBody:
        required: true
        content:
          text/plain:
            schema:
              type: string
      responses:
        '200':
          description: Failpoint set
    delete:
      operationId: deleteFailpoint
      summary: Delete Failpoint
      description: Removes an active failpoint.
      tags:
      - Debug
      parameters:
      - name: failpoint
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Failpoint removed