v24

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-19169310464.0 KB

users

Create a SOCKS5 user

Creates a SOCKS5 credential, optionally bound to a proxy for dedicated routing. Username and password are generated when omitted.

post/connect/users

passwordstring

Desired SOCKS5 password, 1-255 bytes (RFC 1929). Generated when omitted.

proxyIdstring uuid

Proxy to bind the user to for dedicated routing.

usernamestring

Desired SOCKS5 username, 1-255 bytes (RFC 1929). Generated when omitted.

The created user, including its password.

createdAtstring date-time required

idstring uuid required

proxyIdstring uuid nullable

The proxy this user routes to (dedicated routing), or null if unbound.

usernamestring required

passwordstring required