ProxyWhirl Docs
API

REST/OpenAPI Reference

FastAPI OpenAPI summary generated from proxywhirl.api.app.

REST/OpenAPI Reference

Generated reference. This page is derived from proxywhirl.api.app.openapi() during pnpm --dir web run docs:generate. Edit web/scripts/generate-docs.mjs, not this MDX file.

ProxyWhirl API
API
Version 1.0.0
21
Paths
OpenAPI path entries
25
Operations
HTTP method + path pairs
46
Schemas
Request/response models

Route Areas

AreaOperations
proxies8
metrics4
circuit-breakers3
config2
retry2
health1
ready1
request1
rotate1
stats1
status1

Operation Inventory

MethodPathOperation
POST/api/requestMake proxied HTTP request
GET/api/proxiesList all proxies
POST/api/proxiesAdd new proxy
GET/api/rotateSelect next proxy
GET/api/proxies/streamStream all proxies as NDJSON
GET/api/proxies/exportExport all proxies as streaming JSON
POST/api/proxies/health-checkHealth check proxies
POST/api/proxies/testHealth check proxies (deprecated)
GET/api/proxies/{proxy_id}Get proxy by ID
DELETE/api/proxies/{proxy_id}Delete proxy
GET/api/healthAPI health check
GET/api/readyAPI readiness check
GET/api/statusGet system status
GET/api/statsGet performance statistics
GET/api/configGet current configuration
PUT/api/configUpdate configuration
GET/api/retry/policyGet global retry policy
PUT/api/retry/policyUpdate global retry policy
GET/api/circuit-breakersList all circuit breaker states
GET/api/metrics/circuit-breakersGet circuit breaker metrics
GET/api/circuit-breakers/{proxy_id}Get circuit breaker state for specific proxy
POST/api/circuit-breakers/{proxy_id}/resetManually reset circuit breaker
GET/api/metrics/retriesGet retry metrics summary
GET/api/metrics/retries/timeseriesGet time-series retry data
GET/api/metrics/retries/by-proxyGet per-proxy retry statistics

Python API Reference

Source-grounded public exports from proxywhirl.__all__.

CLI Reference

Typer command inventory parsed from proxywhirl.cli.

On this page

REST/OpenAPI ReferenceRoute AreasOperation Inventory