Add whitelist IP

POSThttps://www.eclipseproxy.com/api/reseller/v1/subusers/{id}/whitelistBearer auth

Add an IP to a subuser's whitelist.

Example request

curl -X POST "https://www.eclipseproxy.com/api/reseller/v1/subusers/SUBUSER_ID/whitelist" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ip": "192.168.1.50"}'

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

Body parameters

ipbodystringrequired

The IP address to whitelist.

Example request body

{
  "ip": "192.168.1.50"
}

Example response

{
  "status": "success",
  "message": "IP added to whitelist",
  "messageCode": "IP_ADDED",
  "data": {
    "username": "MYSTORE_user1",
    "whitelistIPs": ["192.168.1.1", "10.0.0.1", "192.168.1.50"]
  }
}

Errors

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