Skip to main content
GET
JavaScript

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>
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.