Repository navigation
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.
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.
Errors are JSON: {"detail": "<message>"}, with a 4xx status for a client mistake and 5xx for a server-side failure.
mitm-proxy | Async Python MITM proxy with a self-signed CA — HTTP/1.1 & HTTP/2, pluggable middleware for inspecting and rewriting traffic in flight.
GitHub • Releases • Issues • Changelog • Contributing
This wiki is generated from docs/wiki/ on every push to main: edits made here are overwritten. Change it with a pull request.
- 🔍 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