Skip to main content
The Reseller API lets reseller-tier accounts manage their bandwidth pool and create and manage sub-accounts (subusers). You allocate bandwidth from your pool to subusers, who then use proxy services under your store code.

​
Who can use it

These endpoints require a RESELLER account. If your account isn’t a reseller, every request returns 403 NOT_RESELLER. To upgrade, contact support via the website chat.

​
Base URL

https://www.eclipseproxy.com
All reseller endpoints live under /api/reseller/v1/.

​
Authentication

Every endpoint authenticates with your reseller API key. Pass it one of two ways: Bearer token: 
Authorization: Bearer YOUR_API_KEY
API key header: 
X-API-Key: YOUR_API_KEY
Get your API key from your dashboard.

​
Authentication errors

StatusCodeMeaning
401UNAUTHORIZEDMissing or invalid API key
403NOT_RESELLERAccount is not a reseller
{
  "status": "error",
  "message": "Unauthorized",
  "messageCode": "UNAUTHORIZED",
  "data": null
}

​
Response format

Every response follows the same envelope: 
{
  "status": "success",
  "message": "Human-readable message",
  "messageCode": "MACHINE_READABLE_CODE",
  "data": null
}
  • status: "success" or "error"
  • message: human-readable summary
  • messageCode: stable, machine-readable code for branching logic
  • data: the payload, or null

​
Status codes

CodeMeaning
200OK
201Created
400Bad request (invalid input)
401Unauthorized (missing or invalid API key)
403Forbidden (not a reseller)
404Not found (resource doesn’t exist)
409Conflict (e.g. username already taken)
422Unprocessable entity (validation error)

​
Endpoints

Get bandwidth info

Pool balance and account overview

List subusers

All subusers under your account

Create subuser

Create a subuser and allocate bandwidth

Get subuser

Details for one subuser

Update password

Reset a subuser’s password

Get IP whitelist

A subuser’s whitelisted IPs

Add whitelist IP

Whitelist an IP for a subuser

Remove whitelist IP

Remove a whitelisted IP

Subuser bandwidth

Allocation and usage for a subuser

Bandwidth history

Allocation history for a subuser

​
Notes

  • Subuser naming: usernames are automatically prefixed with your storeCode. Passing user1 creates MYSTORE_user1.
  • Bandwidth units: all bandwidth values are in MB.
  • Store code: assigned when your account is created and cannot be changed.
  • Subuser provisioning: subusers are created upstream and synced to your account.