DBTrail API

openapi: 3.1.0
info:
  title: DBTrail API
  version: '2026-11-05'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-05: 7 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; DBTrail has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 3
    pages-with-code: 4
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-05'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://dbtrail.com/docs/quickstart
  - https://dbtrail.com/docs/guides/dashboards
  - https://dbtrail.com/docs/guides/recovery
  - https://dbtrail.com/docs/guides/linux-packages
  - https://dbtrail.com/docs/claude/setup
  - https://dbtrail.com/docs/monitoring/status
paths:
  /api/healthz:
    get:
      operationId: get_api_healthz
      tags:
      - Api
      summary: GET /api/healthz
      x-source: https://dbtrail.com/docs/claude/setup
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl http://host:8090/api/healthz from there \n Full table: troubleshooting .\nSQL clients use a different door: ProxySQL integration\
          \ for Flashback . \n Headless setups (no web interface) \n Standalone bintrail-mcp reads the index DSN directly, over stdio or --http\
          \ :\n MCP server reference . MariaDB Capture changes from MariaDB, added from the web interface like a MySQL server, nothing installed\
          \ in you"
  /api/recover:
    post:
      operationId: post_api_recover
      tags:
      - Api
      summary: Recovery Undo a wrong DELETE, UPDATE or INSERT on specific rows.
      x-source: https://dbtrail.com/docs/guides/recovery
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/status:
    get:
      operationId: get_api_status
      tags:
      - Api
      summary: the Status view as JSON, access token required.
      x-source: https://dbtrail.com/docs/monitoring/status
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /dbtrail/dbtrail/main/install.sh:
    get:
      operationId: get_dbtrail_dbtrail_main_install_sh
      tags:
      - Dbtrail
      summary: GET /dbtrail/dbtrail/main/install.sh
      x-source: https://dbtrail.com/docs/quickstart
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL https://raw.githubusercontent.com/dbtrail/dbtrail/main/install.sh | sh It starts DBTrail and opens http://127.0.0.1:8090\
          \ in your browser. Your history lives in the\nDocker volumes of this stack: from the dbtrail folder, docker compose down stops DBTrail\
          \ and\nkeeps it, docker compose down -v deletes it . Other ports and options:\n installation guide .\nWithout Docker: Install from Linux\
          \ pack"
  /dbtrail/dbtrail/releases/download/v:
    get:
      operationId: get_dbtrail_dbtrail_releases_download_v
      tags:
      - Dbtrail
      summary: GET /dbtrail/dbtrail/releases/download/v
      x-source: https://dbtrail.com/docs/guides/linux-packages
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSLO https://github.com/dbtrail/dbtrail/releases/download/v $V /bintrail-console_ ${V} _linux_ $( dpkg --print-architecture\
          \ ) .deb \n sudo apt install ./bintrail-console_ ${V} _linux_ * .deb V = 0.103.0 \n A = $( uname -m | sed 's/x86_64/amd64/; s/aarch64/arm64/'\
          \ ) "
  /motherduckdb/metabase_duckdb_driver/1.5.5.0/Dockerfile:
    get:
      operationId: get_motherduckdb_metabase_duckdb_driver_1_5_5_0_Dockerfile
      tags:
      - Motherduckdb
      summary: GET /motherduckdb/metabase_duckdb_driver/1.5.5.0/Dockerfile
      x-source: https://dbtrail.com/docs/guides/dashboards
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -LO https://raw.githubusercontent.com/motherduckdb/metabase_duckdb_driver/1.5.5.0/Dockerfile \n docker build -t metabase-duckdb\
          \ --build-arg METABASE_DUCKDB_DRIVER_VERSION= 1.5.5.0 . \n docker run -d --name metabase -p 3000:3000  -v < folde r > _bintrail-state:/var/lib/bintrail:ro\
          \  -v \" $PWD :/bi:ro\"  metabase-duckdb \n 4. Add the database \n In Metabase, Admin settings > Databases > Add a databas"
  /mydumper/mydumper/releases/download/v1.0.3-1/mydumper_1.0.3-1.noble_amd64.deb:
    get:
      operationId: get_mydumper_mydumper_releases_download_v1_0_3_1_mydumper_1_0_3_1_noble_amd64_de
      tags:
      - Mydumper
      summary: Install from Linux packages
      x-source: https://dbtrail.com/docs/guides/linux-packages
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
tags:
- name: Api
- name: Dbtrail
- name: Motherduckdb
- name: Mydumper