Linking & Monitoring Servers
Once you are verified, you can link one or more QuickBox Pro servers to your Discord account. QBXWatcher then answers questions about those servers on demand — CPU, memory, disks, uptime, installed apps, bandwidth, and pending package updates.
QBXWatcher reads your server when you run a command. It does not poll or watch your box in the background. The single exception is the health alert you turn on yourself with /server alerts, and that sends a DM only when a threshold is crossed.
Linking a server
/server addQBXWatcher first looks at the server activations already on your v3.quickbox.io account:
| What it finds | What happens next |
|---|---|
One active server | It offers a one-click Link button for that server |
Several active servers | It shows a picker with each server's label and when it was last seen |
No activations | It points you at the portal to activate a server, and offers the manual form |
Every case also offers Enter manually, which opens a private form:
| Field | What to enter |
|---|---|
Server URL | Hostname or address of the box, for example myserver.example.com or 192.168.1.100 |
READ_KEY | Your server's read key, taken from the dashboard under System > API Control > QB Control API |
If the direct connection succeeds the reply confirms Connected. If the box is not directly reachable but is already reporting telemetry to QuickBox, the link is still made and marked Linked via telemetry.
Run /server add again for each server you own. Commands that take a host option autocomplete from the servers you linked, so you can pick which one to query.
To unlink:
/server removeYou get a picker of your linked servers and a confirmation step before anything is removed.
Checking your server
/server status
CPU, memory, swap, disks, OS and kernel, uptime, load average, network throughput and pending package updates
/server apps
Installed QuickBox software grouped by user, with versions and ports
/snapshot run
One-embed health overview pulling status, apps, bandwidth, downloads and updates together
/uptime
Bot uptime with no options; pass a host and it reports that server's uptime instead
/system-status
Focused system status readout for a linked server
/system-speedtest
Runs a speedtest on the server and reports ping, download, upload, ISP and test server
Shared options
Most server-facing commands accept the same options:
| Option | What it does |
|---|---|
host | Which linked server to query. Autocompletes from your saved servers; omit it if you only linked one |
read_key | Override the stored read key for a single run — useful right after you rotate it |
show | Post the reply publicly in the channel. Default is private to you |
hidden | Mask the hostname in the output so you can safely share it in a thread |
user | Query another member's server. Restricted to admins |
Combine the two: show:true hidden:true posts the readout where a helper can see it while keeping your hostname out of the message.
Snapshots
/snapshot runA single condensed embed with the headline numbers for your server. Results are cached briefly, so running it twice in quick succession returns the cached copy and tells you how long is left on it.
/snapshot detailAn expanded snapshot with the top-10 apps and 30-day bandwidth. This one is restricted to moderators, admins and support staff — it is the view they use when helping you in a thread.
Health alerts
/server alerts toggle:on
/server alerts toggle:offWith alerts on, QBXWatcher DMs you when one of your linked servers crosses a threshold.
| Alert | Warning | Critical | Notes |
|---|---|---|---|
Disk usage | above 85% | above 90% | Checked per monitored mount, including network mounts |
RAM usage | above 90% | above 95% | |
Load average | above 6 | above 8 |
You receive at most one alert per type every two hours, so a server that sits above a threshold does not flood your DMs. Each alert tells you to run /server status for detail.
Connectivity checks
/ping
/ping host:example.comWith no options, /ping reports the bot’s own latency. Give it a host and it pings that host instead. verbose adds internal diagnostics, show posts publicly, and hidden obfuscates the host in the reply.
/healthReports the bot’s own health and infrastructure connectivity. Add verbose:true for detailed diagnostics. This is about the bot, not your server — use /server status for your box.
Best practices
Do
- Use a read-only key — nothing on this page needs write access
- Link each server with a clear label so the
hostautocomplete stays readable - Use
hidden:truebefore posting any server output into a public thread - Turn on
/server alertsif you run a box with tight disk headroom - Run
/server removewhen you decommission a server so stale entries do not clutter autocomplete
Don't
- Do not paste a read key into a channel — use the private form, or the
read_keyoption which is never echoed back - Do not rely on the bot as your only monitoring; it reads on demand, not continuously
- Do not use
show:truefor status output unless you have also sethidden:true - Do not link a server you do not administer
FAQ
Related pages
Join the Community
Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.