VPN catalog API
A stable, authenticated interface for your server catalog, app configuration, and OpenVPN profiles.
/api/public/v1STABLEGetting started
Send requests to the base URL with your shared wrapper key in the x-api-key header. The provider address and any provider credentials remain server-side.
curl "/api/public/v1/servers?page=1&per_page=20" \ -H "x-api-key: YOUR_WRAPPER_KEY"
Authentication
All catalog endpoints require the shared API key. Include it with every request. The key is checked before forwarding a call.
x-api-key: YOUR_WRAPPER_KEYMissing or invalid keys receive 401 Unauthorized. Never put the key in a URL, browser app, public repository, or mobile binary; keep it in a trusted server environment.
Endpoints
/app-configApplication name, branding, social links, and gate policy.
/servers?page=1&per_page=20Paginated VPN server catalog.
/servers/{id}Details and availability for a server ID.
/servers/{id}/profile SENSITIVERaw OpenVPN profile for the selected server. Treat the response as sensitive configuration.
/countriesAvailable countries and flag metadata.
/apk-updates/latestLatest APK version and update metadata.
Only the routes shown above are forwarded. Unsupported paths and methods are rejected.
Pagination
Use the server list query parameters below. Responses retain the provider envelope, including current page, last page, page size, total, and navigation links.
pageProvider default1 – 100,000per_pageProvider default1 – 100Responses & limits
- Successful calls pass through the provider status, body, and selected safe response headers.
- Unknown paths return
404; invalid pagination values are rejected before forwarding. - Provider unavailable or timed out returns
502. - Response size is capped at 8 MB; calls time out after 12 seconds.
- Usage policy permits GET only; request bodies, cookies, and caller-supplied provider headers are not forwarded.
Security & monitoring
Upstream address and response headers that identify it are not exposed.
Only route name, status, duration, and time are retained for 24-hour aggregates.
API keys, request content, caller IP addresses, and VPN profile contents are never saved to monitoring records. Profile responses should still be handled as sensitive material by the calling service.