Box’a’Fox
API referenceProxy users

Read proxy user

GET
/v1/proxy-users/{id}

{id} is the UUID or the username. 404 not_found for other customers' users.

Authorization

ApiKey
headerX-API-Key<token>

prx_live_<40 base62>

Path Parameters

id*string

UUID or username.

Response Body

OK

application/json
  1. response
data*
message*string

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

curl -X GET "https://example.com/v1/proxy-users/string"
{  "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"}

Delete proxy user DELETE

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

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.