Box’a’Fox
API referenceProxy users

Delete proxy user

DELETE
/v1/proxy-users/{id}

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

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 DELETE "https://example.com/v1/proxy-users/string"
{  "data": {    "deleted": true,    "id": "string"  },  "message": "OK"}

Create proxy user POST

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).

Read proxy user GET

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