Create a proxy
Provisions a proxy of the requested type for the caller in the selected country.
Headers
Optional idempotency key, unique per owner (1-128 characters after trimming; surrounding whitespace is ignored). Reusing a key returns the originally created proxy with its original credentials, regardless of changed request parameters.
Body
Response
The created proxy, including its password.
A proxy including its password. Returned only on create and single-proxy reads.
ISO 3166-1 alpha-2 country code (lowercase).
Lifecycle of a proxy. A freshly created proxy is checking while its billing identity is being resolved — clients should poll until a paymentUrl or a later status appears — then 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.
checking, pending_payment, provisioning, active, cancelling, ended, error dedicated_residential, residential, mobile included, standalone_paid Checkout URL to complete payment while status is pending_payment. Null once paid or when no payment was required.