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

Stop a modem and take its proxy offline

Use this to stop a modem on purpose, for example to save data. Marks the slot as stopped by web, logs a stopped event and disconnects the modem; the stop survives a restart and rotations are refused until POST /v2/connect_dongle. Needs the IP-rotation license feature.

  • Destructive · confirm first
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • disconnectDongle
POST/v2/disconnect_dongle

Request body application/json · required

positionintegerrequired

Slot number (position) on the box, starting at 1. A missing or non-integer value makes the box answer HTTP 500.

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

Stop requested, or need_upgrade.

statusbooleanoptional
msgstringoptional

Errors returned in msg

msgMeaningWhat to do
need_upgradeThe license does not include IP rotation.Upgrade the license plan.
Verified against XProxy v21.3.2 on Nov 17, 2026