Skip to Content
DocsDiscord BotLinking and Monitoring Your Servers from Discord

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.

On demand only

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 add

QBXWatcher first looks at the server activations already on your v3.quickbox.io account:

What it findsWhat 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:

FieldWhat 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.

Link more than one

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 remove

You 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:

OptionWhat 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
Sharing output in a support thread

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 run

A 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 detail

An 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:off

With alerts on, QBXWatcher DMs you when one of your linked servers crosses a threshold.

AlertWarningCriticalNotes
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
Alerts are rate-limited

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.com

With 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.

/health

Reports 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 host autocomplete stays readable
  • Use hidden:true before posting any server output into a public thread
  • Turn on /server alerts if you run a box with tight disk headroom
  • Run /server remove when 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_key option 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:true for status output unless you have also set hidden:true
  • Do not link a server you do not administer

FAQ

In your QuickBox dashboard under System > API Control > QB Control API. Use the read-only key — status commands never need write permissions.
If your box is behind NAT or a firewall, the bot may not be able to connect to it from the internet. If the server is already reporting telemetry to QuickBox, the link still succeeds and readouts are served from that telemetry, marked 'via telemetry' and stamped with when it was last updated.
Yes — supply the LAN address when linking. Direct queries will only succeed if the bot can route to it, so LAN-only boxes typically fall back to telemetry-backed readouts.
When the readout is served from telemetry rather than a live connection, only apps with update tracking are included. The bot labels that case in the embed footer.
Pass the new key once with the read_key option to confirm it works, then re-link the server with /server add so the stored key is updated.
No. Replies are private unless you set show:true. Only admins can target another member's server, and that is used for support.
The expanded snapshot is limited to moderators, admins and support staff. Use /snapshot run for your own server, or ask in your support thread and staff will pull the detailed view.

Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

Dedicated Support
Feature Previews
Community Configs
Active Discussions
Join Discord Server
Last updated on