API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Proxy settings

Page through every public IP the modems have had, with reuse scores

Returns the full public-IP history (no time window), grouped by IP, with how often each IP came back. score drops by one per repeat; freshness is fresh when the score is at or above the IP history guard's threshold, else warning. Summary fields cover all IPs matching search.

  • Read only
  • Basic auth
  • Panel API · since v20.9.85
  • Hub: routine call
  • getIpPools
GET/v2/ip_pools

Query parameters

pageintegeroptional

Page number from 1.

Default 1Example 1
page_sizeintegeroptional

Rows per page (1–200).

Default 50Example 50
searchstringoptional

Filter on the IP text.

Example 203.0.113

Authentication

Needs a trusted caller (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) or valid dashboard Basic credentials, which are checked only when dashboard authentication is enabled.

Responses

One page of IPs, or status false with the error text.

statusbooleanoptional
msgstringoptional
dataobjectoptional
data.unique_ipsintegeroptional
data.total_rotationsintegeroptional
data.freshness_rateintegeroptional

Percent of IPs on this page that are fresh.

data.avg_usesnumberoptional
data.pageintegeroptional
data.page_sizeintegeroptional
data.totalintegeroptional
data.ipsobject[]optional
data.ips[].ip_addressstringoptional
data.ips[].scoreintegeroptional
data.ips[].repeatsintegeroptional
data.ips[].freshnessstringoptional
One of fresh, warning, stale, unknown
data.ips[].modems_usedintegeroptional
data.ips[].last_seennumberoptional

Unix time (seconds).

data.ips[].first_seennumberoptional

Unix time (seconds).

Errors returned in msg

msgMeaningWhat to do
(exception text)Reading the IP history failed.Retry; check the controller log if it persists.
Verified against XProxy v21.3.2 on Nov 17, 2026