JavaScript
Proxy
Connect proxy
Routes the device’s traffic through a SOCKS5 proxy supplied in the request body, replacing any existing connection. A smartIp option can be used to select an IP automatically; the legacy flat host/port/user/password fields remain supported.
POST
JavaScript
Provide exactly one proxy definition: the
socks5 object, or the deprecated flat host/port/user/password fields (all four required together). Sending both fails validation.
With smartIp: true, the API geolocates the proxy’s exit IP through the proxy itself and aligns the device to match — GPS location, time zone, locale, and (unless an eSIM is active) mobile carrier and network type.
Authorizations
Bearer token via Authorization header
Headers
Required range:
x >= 0Path Parameters
Body
application/json
Maximum string length:
255Proxy name
Maximum string length:
255Maximum string length:
255Required range:
1 <= x <= 65535SOCKS5 proxy configuration (required for socks5).
Maximum string length:
255Response
No Content