Skip to main content
POST
JavaScript

Body

application/json
password
string

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

Required string length: 1 - 255
proxyId
string<uuid>

Proxy to bind the user to for dedicated routing.

username
string

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

Required string length: 1 - 255

Response

The created user, including its password.

A SOCKS5 user including its password. Returned only on create and single-user reads.

createdAt
string<date-time>
required
id
string<uuid>
required
username
string
required
password
string
required
proxyId
string<uuid> | null

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