Sign in

v24

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-19169310464.0 KB
proxies

Create a proxy

Provisions a proxy for the caller in the selected country.

post/connect/proxies

Request body

countrystring country-code required

ISO 3166-1 alpha-2 country code to provision the proxy in.

type'residential'

Response

The created proxy, including its password.

countrystring required

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

createdAtstring date-time required
hoststring required
idstring uuid required
portinteger required
status'pending_payment' | 'provisioning' | 'active' | 'cancelling' | 'ended' | 'error' 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.

type'residential' required
usernamestring required
passwordstring required
paymentUrlstring nullable

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