Skip to main content
GET
/
connect
/
proxies
/
{id}
JavaScript
import Mobilerun from '@mobilerun/sdk';

const client = new Mobilerun();

const proxy = await client.connect.proxies.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(proxy.id);
{
  "country": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "host": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "port": 123,
  "type": "dedicated_residential",
  "username": "<string>",
  "password": "<string>",
  "paymentUrl": "<string>"
}

Response

The proxy, including its password.

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

​
country
string
required

ISO 3166-1 alpha-2 country code (lowercase).

​
createdAt
string<date-time>
required
​
host
string
required
​
id
string<uuid>
required
​
port
integer<int32>
required
​
status
enum<string>
required

Lifecycle of a proxy. A freshly created proxy is provisioning — or pending_payment until the customer completes checkout — and becomes active once its upstream is assigned. cancelling retains full access through the paid period; when the subscription expires the proxy is ended. error marks a failed provisioning attempt.

Available options:
pending_payment,
provisioning,
active,
cancelling,
ended,
error
​
type
enum<string>
default:dedicated_residential
required
Available options:
dedicated_residential,
residential,
mobile
​
username
string
required
​
password
string
required
​
paymentUrl
string | null

Checkout URL to complete payment while status is pending_payment. Null once paid or when no payment was required.