Create a proxy
Provisions a proxy of the requested type for the caller in the selected country.
Authorizations
Bearer token via Authorization header
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
ISO 3166-1 alpha-2 country code to provision the proxy in.
dedicated_residential, residential, mobile Display name for the proxy, up to 64 characters excluding surrounding whitespace, and containing no NUL. Omit it (or send only whitespace) to get a generated label built from the country, type, and id.
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).
Display name for the proxy. Set it on create or change it with PATCH; when no name has been set, a label generated from the proxy's country, type, and id is returned instead — so this is never empty.
"🇩🇪 Germany · Dedicated residential · 769fc289"
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.