Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

Idempotency-Key
string

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

application/json
country
string<country-code>
required

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

type
enum<string>
required
Available options:
dedicated_residential,
residential,
mobile
name
string

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.

country
string
required

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

createdAt
string<date-time>
required
host
string
required
id
string<uuid>
required
name
string
required

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.

Example:

"🇩🇪 Germany · Dedicated residential · 769fc289"

port
integer<int32>
required
status
enum<string>
required

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.

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

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