POST
Create a Sub

Authorizations

Authorization
string
header
required

[just text field] Please enter token in following format: Bearer

Body

application/json
quantity
number
required

Number of proxy IPs to allocate. For subnet pools (pool name starts with "TL_SN_"), use 256 to allocate 256 IP addresses. For all other pools, use a value between 1 and 200 to allocate that many IP addresses. Make sure the selected pool has enough available stock for the requested quantity (use Get all pools to check stock).

pool_id
string
required

ID of the proxy pool to allocate proxies from (e.g. "TL004"). Use Get all pools (GET /v3/tl-isps/pools) to retrieve the available pools and their IDs.

is_socks
boolean
default:false
required

Whether to create the proxy as a SOCKS5 proxy (true) or an HTTP proxy (false). Defaults to false (HTTP). Note: creating a SOCKS5 proxy assigns a new HTTP port, but the previous HTTP port keeps working. SOCKS5 proxies also support UDP.

is_test
boolean
required

Whether to create a test proxy (true) or a regular proxy (false). Test proxies are dummy proxies that cannot be used; regular proxies are actual, usable proxies.

username
string
required

Username for proxy authentication. If omitted, a username is generated automatically. Must be 8-12 characters long, contain only letters, numbers and underscores, and cannot start or end with an underscore.

idempotency_key
string<uuid>

UUID used to make order creation idempotent within the reseller account. Requests without an idempotency_key are not idempotent.

Example:

"9a7b3309-6e07-4d50-a460-ccf56564ddeb"

Response

User created

userId
string
required
pool
object
required
orderTime
string<date-time>
required
expiry
string<date-time>
required
quantity
number
required
status
string
required
proxyList
string[]
required
idempotencyKey
string<uuid>

The customer-generated idempotency identifier.

Example:

"9a7b3309-6e07-4d50-a460-ccf56564ddeb"