MeshProx
Sign inGet started

Documentation

Quick reference for onboarding servers and automating proxy operations. Full interactive docs live in the dashboard Settings after login.

Onboarding flow

  1. Add server SSH credentials in the dashboard
  2. Run preflight — validates IPv6 and opens UFW proxy ports on the VPS automatically
  3. Install agent (one-time, outbound WebSocket to https://api.meshprox.com)
  4. Generate proxies and export

API base URL

https://api.meshprox.com/v1

Key endpoints

  • POST /v1/proxies/generate — server_id, count, mode, protocol
  • GET /v1/proxies/export — format=txt|csv
  • POST /v1/servers/:id/preflight — verify_proxy optional
  • GET /v1/health — fleet status (API key auth)

Export formats

SOCKS5: socks5://user:pass@host:port · HTTP/HTTPS URL schemes for HTTP clients.

Read tutorials on the blog →