- API Reference
- Box API
- 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.
/v2/disconnect_dongleRequest body application/json · required
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.
The caller is not trusted (not loopback, LAN, whitelisted or allowed Tailscale) and sent no valid Basic credentials. The body depends on whether "Basic auth for all API" is on. Routes that also use the panel login can answer a plain-text 401 "Unauthorized Access" instead.
Unhandled error, for example a non-integer position or a missing required parameter.
Error name, e.g. internal_server_error or bad_request.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
need_upgrade | The license does not include IP rotation. | Upgrade the license plan. |