Skip to main content
GET
Get subuser bandwidth
Retrieve bandwidth allocation and usage for a specific subuser.

Authentication

Requires a reseller API key. Pass it as Authorization: Bearer YOUR_API_KEY or X-API-Key: YOUR_API_KEY. See Reseller overview.

Path parameters

id
string
required
The subuser username (full prefixed username, e.g. MYSTORE_user1).

Response

username
string
Full prefixed username.
bandwidthAllocated
number
Total bandwidth allocated to the subuser (MB).
bandwidthUsed
number
Bandwidth consumed so far (MB).
bandwidthRemaining
number
Bandwidth still available (MB).

Example response

Errors

  • 401 UNAUTHORIZED: missing or invalid API key
  • 403 NOT_RESELLER: account is not a reseller
  • 404 NOT_FOUND: no subuser with that username