Organization
Tokens and scopes
Give each token only the scopes it needs; an endpoint outside its scopes returns 403.
When you create a token, you choose one or more scopes. Read scopes on their own cannot touch your balance: operations that spend money need a separate scope (orders:write), and settings changes need another one (proxies:write).
Scopes
| Scope | Name | Description |
|---|---|---|
orders:read | Service information | Days left, traffic used, request and error counts; catalog, stock and price quotes. |
proxies:read | Proxy list | Proxy addresses and login details. Contains credentials; grant it with care. |
logs:read | Logs | Request logs. Your plan must also include log access. |
orders:write | Ordering | Places new proxy orders and CHARGES YOUR BALANCE. Grant it only to an integration that will actually make purchases. |
proxies:write | Proxy settings | Changes the settings of existing services, such as the service name and traffic limit. Spends no money. |
Which scope opens which endpoints
orders:read
- GET
/meToken and organization info - GET
/catalogCatalog - GET
/locationsLocations - GET
/target-urlsTarget domains - GET
/stockStock check - GET
/pricingPrice quote - GET
/ordersList services - GET
/orders/{id}Service details - GET
/orders/{id}/usage-historyUsage history
proxies:read
- GET
/orders/{id}/accessAccess lists - GET
/orders/{id}/connectionAccess details - GET
/orders/{id}/proxiesProxy list
logs:read
orders:write
proxies:write
Recommended scope sets
| Integration | Scopes |
|---|---|
| Usage and expiry monitoring | orders:read |
| Passing the proxy list to your customers | orders:read, proxies:read |
| Log analysis | orders:read, logs:read |
| Automated purchases and renewals | orders:read, orders:write, proxies:read |
| Name and traffic limit automation | orders:read, proxies:write |
When the username and password are generated with the order, the token also needs proxies:read for them to be returned in the response.