Get subuser bandwidth

GET /api/reseller/v1/subusers/{id}/bandwidth: allocation and usage for a subuser

GEThttps://www.eclipseproxy.com/api/reseller/v1/subusers/{id}/bandwidthBearer auth

Retrieve bandwidth allocation and usage for a specific subuser.

Example request

curl -X GET "https://www.eclipseproxy.com/api/reseller/v1/subusers/SUBUSER_ID/bandwidth" \
  -H "Authorization: Bearer YOUR_API_KEY"

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

idpathstringrequired

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

Response

usernamestring

Full prefixed username.

bandwidthAllocatednumber

Total bandwidth allocated to the subuser (MB).

bandwidthUsednumber

Bandwidth consumed so far (MB).

bandwidthRemainingnumber

Bandwidth still available (MB).

Example response

{
  "status": "success",
  "message": "OK",
  "messageCode": "OK",
  "data": {
    "username": "MYSTORE_user1",
    "bandwidthAllocated": 100,
    "bandwidthUsed": 15,
    "bandwidthRemaining": 85
  }
}

Errors

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