Box’a’Fox
API referenceProxy users

Rotate password

POST
/v1/proxy-users/{id}/reset-password

Send a password in the body, or leave it out to have one generated. The old password stops working within a second.

Authorization

ApiKey
headerX-API-Key<token>

prx_live_<40 base62>

Path Parameters

id*string

UUID or username.

Request Body

application/json
  1. body
password?string
Match^[A-Za-z0-9]+$
Length12 <= length <= 32

Response Body

OK

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/string/reset-password" \  -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"}

List proxy users GET

Passwords are included. Sort: username, created_at, residential_bytes_used, mobile_bytes_used. Filters: status, username, like_username, is_default, min_/max_*_bytes_used, metadata.<key>, include_deleted.

Update limits, status, metadata PATCH

Limit below current usage → 422 limit_below_usage. Default user cannot be disabled (409 conflict).