Skip to main content
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.
A smart IP failure leaves your existing proxy untouched, but a failure while connecting the new proxy can leave the device with no proxy at all. Check the proxy state before retrying.

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

X-Device-Display-ID
integer<int64>
default:0
Required range: x >= 0

Path Parameters

deviceId
string
required

Body

application/json
host
string<hostname>
deprecated
Maximum string length: 255
name
string

Proxy name

Maximum string length: 255
password
string
deprecated
write-only
Maximum string length: 255
port
integer<int64>
deprecated
Required range: 1 <= x <= 65535
smartIp
boolean
socks5
object

SOCKS5 proxy configuration (required for socks5).

user
string
deprecated
Maximum string length: 255

Response

No Content