API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Modems

Queue a speed test through the proxies of some modems

Use this to measure download speed of slots. Only queues the test (a slot already queued less than a minute ago is skipped); results appear later in the slot data of the panel. One unknown position fails the whole call with the generic error.

  • Action · reversible
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • speedtestProxy
POST/v2/speedtest_proxy

Request body application/json · required

positionsinteger[]required

Slot numbers (positions) to change.

Authentication

Needs dashboard Basic credentials when dashboard authentication is enabled; trusted callers (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) pass without them.

Responses

Queued, or the generic error.

statusbooleanrequired

True when the box accepted the request.

msgstringrequired

Outcome code or message (see the operation's error table).

Errors returned in msg

msgMeaningWhat to do
Have an error during request! Contact administrator!positions missing or one position has no modem.Send only positions that hold a modem.
Verified against XProxy v21.3.2 on Nov 17, 2026