Skip to main content
POST
/
devices
/
{deviceId}
/
proxy
JavaScript
import Mobilerun from '@mobilerun/sdk';

const client = new Mobilerun({
  apiKey: process.env['MOBILERUN_CLOUD_API_KEY'], // This is the default and can be omitted
});

await client.devices.proxy.connect('deviceId');
{
  "$schema": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

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