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
fetches the credentials of an existing Connect proxy owned by the device’s
owner (it must be
provisions a rotating residential proxy in that country — or reuses the
one previously provisioned for this device when it is still active and in
the same country. Provisioning waits up to 60 s for the proxy to become
active. If payment is required first, the request fails with
socks5 object, the deprecated flat host/port/user/password fields (all four required together), or a Mobilerun Connect connect reference (see below). Sending more than one fails validation.
Mobilerun Connect proxies
Instead of passing credentials, reference a Mobilerun Connect proxy:active or cancelling), while
402 PAYMENT_REQUIRED and a paymentUrl detail pointing to checkout.
With smartIp: true, the exit-IP precheck probes the proxy for up to ~45 s,
so a freshly provisioned proxy that is still being routed passes without
caller-side retries. If the precheck still fails, the error tells you why:
409 CONNECT_PROXY_NOT_ACTIVE— the proxy is not (or no longer) serving traffic, e.g. still provisioning. Transient while provisioning: retry in a few seconds.- A denial that keeps failing while the proxy is
activeusually means the organization is out of prepaid proxy data. The same error can occur briefly during transient failures, so it surfaces as a generic error rather than a billing one: retry, and check your proxy data balance if retries keep failing.
id or country, and don’t combine connect with
socks5 or the legacy flat fields. smartIp works with all variants.
A proxy provisioned via country stays with the device and is cancelled
automatically when the device is terminated. Proxies referenced by id
are never cancelled by this API.
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.
On some device types, an upstream switch on an already-proxied device applies live with no interruption, but the first time a device gets a proxy the device restarts to pick it up.
Body
application/json
Response
No Content
JavaScript