Skip to content

HTTP API Reference

github-actions[bot] edited this page Oct 28, 2026 · 4 revisions

HTTP API Reference

The server listens on port 8080 by default. The live OpenAPI schema is served at /openapi.json, and interactive docs at /docs.

Endpoints

Generated from the code: don't edit the table, run uv run scripts/gen-wiki.py.

Method Path Summary
GET /healthz Liveness: the process is up
GET /readyz Readiness: able to serve requests
GET /version The running version

/healthz (liveness) answers as long as the process runs. /readyz (readiness) answers 503 while the service can't serve, for example while a dependency is down. Orchestrators should restart on the first and route traffic on the second.

Authentication

Errors

Errors are JSON: {"detail": "<message>"}, with a 4xx status for a client mistake and 5xx for a server-side failure.

mitm-proxy

GitHub • Releases


📚 Getting Started

📖 Core Concepts

🔧 Configuration

🔒 Security

🆘 Help & Support

🧑‍💻 For Developers


🔑 Key Features

  • 🔍 Intercept only the hosts you list; tunnel the rest untouched
  • 🔀 HTTP/1.1 and HTTP/2 on both sides, bridged
  • 🧩 Python middleware: inspect, rewrite, answer or deny
  • 🔐 Its own root CA; origins always verified
  • 📈 Prometheus metrics and a read-only status API

🔗 Quick Links

Clone this wiki locally