Box’a’Fox
API referenceProxy users

Create proxy user

POST
/v1/proxy-users

The user can connect as soon as the call returns. 409 username_taken when the name is in use; 409 limit_reached when the account has its maximum number of proxy users (limits.proxy_users).

Authorization

ApiKey
headerX-API-Key<token>

prx_live_<40 base62>

Request Body

application/json
  1. body
metadata?
mobile_bytes_limit?integer
Formatint64
Range0 <= value
password?string

Optional → generated 16 chars.

Match^[A-Za-z0-9]+$
Length12 <= length <= 32
residential_bytes_limit?integer
Formatint64
Range0 <= value
username?string

Optional → generated <customer_prefix>_<6 random>.

Match^[a-z0-9_]+$
Length6 <= length <= 32

Response Body

Created

application/json
  1. response
data*
message*string

Human-readable status, safe to show to end users.

curl -X POST "https://example.com/v1/proxy-users" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "deleted_at": "2019-08-24T14:15:22Z",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "is_default": true,    "metadata": {      "property1": null,      "property2": null    },    "mobile_bytes_limit": 0,    "mobile_bytes_used": 0,    "password": "string",    "residential_bytes_limit": 0,    "residential_bytes_used": 0,    "status": "active",    "updated_at": "2019-08-24T14:15:22Z",    "username": "string",    "whitelist_ips": [      "string"    ]  },  "message": "OK"}

Generate residential proxy strings GET

Returns ready-to-use proxy strings. Nothing is created: a sticky session starts with its first connection. Unknown alias → 400 validation_error with details.field; a combination the network does not support → 400 bad_target. Counts as one request for rate limiting whatever the count.

Delete proxy user DELETE

Disables the user and ends its sessions. The username stays reserved. The default user cannot be deleted (409 conflict).