Skip to content

API Reference

Base URL: http://localhost:9000

Authentication: X-API-Key header or ?api_key= query parameter.

Health & Version

MethodPathAuthDescription
GET/api/healthNone{"status":"ok"}
GET/api/versionNoneVersion + build info

Metrics (metrics:read)

MethodPathDescription
GET/metrics?format=json|prometheus|influx|csvGlobal metrics
GET/metrics/proxy/{name}Per-proxy metrics

Proxies (proxies:read / *)

MethodPathDescription
GET/api/proxiesList all proxies
GET/api/proxies/{name}Proxy detail
POST/api/proxies/{name}/enableEnable proxy
POST/api/proxies/{name}/disableDisable proxy
POST/api/proxies/{name}/reloadReload from disk
GET/api/proxies/{name}/connectionsActive connections
DELETE/api/proxies/{name}/connections/{id}Kill connection
GET/api/proxies/{name}/upstreamsUpstream health
POST/api/proxies/{name}/upstreams/{ip}/ejectForce-eject
POST/api/proxies/{name}/upstreams/{ip}/readmitForce-readmit

iptables (*)

MethodPathDescription
GET/api/iptables/rulesActive rules
POST/api/iptables/validateValidate config
POST/api/iptables/flush/{proxy}Flush & recreate
POST/api/iptables/orphan-sweepRemove orphans

L7 (*)

MethodPathDescription
GET/api/l7/bannedBanned IPs
DELETE/api/l7/banned/{ip}Unban
POST/api/l7/banned/{ip}?duration=30mManual ban
GET/api/l7/events?limit=100Block events

ACL (*)

MethodPathDescription
GET/api/acl/globalGlobal rules + stats
POST/api/acl/global/rulesAdd rule
DELETE/api/acl/global/rules?cidr=...Remove rule
PUT/api/acl/global/rulesReplace all
GET/api/acl/proxy/{name}Per-proxy rules
POST/api/acl/proxy/{name}/rulesAdd proxy rule
DELETE/api/acl/proxy/{name}/rules?cidr=...Remove proxy rule
PUT/api/acl/proxy/{name}/rulesReplace all proxy

Bandwidth (metrics:read)

MethodPathDescription
GET/api/bandwidth/proxy/{name}Usage snapshot
POST/api/bandwidth/proxy/{name}/resetReset counters

System (*)

MethodPathDescription
POST/api/reloadReload all configs