1 SABnzbd
David Spitzer edited this page 2026-10-14 15:04:05 -07:00

SABnzbd

Dashboard Status

This module is live. The dashboard reads the SABnzbd queue and recent history through the JSON API.

Primary API surfaces:

/api?mode=queue&output=json
/api?mode=history&output=json

Dashboard Admin Form

SABnzbd settings in the dashboard admin console

The SABnzbd page in /admin, filled with fictional example values from the built-in demo data. Secret fields show as dots while typing and as Saved secret once stored. Use Test saved connection after saving.

Admin Fields

  • SABnzbd URL
  • API Key
  • Low disk warning (GB free) (optional, default 20)
SABnzbd URL: http://downloads.example.lan:8080
API Key: copied-api-key
Low disk warning (GB free): 20

Find The API Key

  1. Open SABnzbd.
  2. Open Config > General.
  3. In the Security section, copy the API Key. Do not use the NZB Key; it cannot read the queue.

What The Card Shows

  • Queue speed, number of items and time left, or Paused / Idle.
  • Failed downloads in the last 24 hours, named, with SABnzbd's failure message.
  • Free disk space for the incomplete and complete folders. The smaller of the two is used, and a warning is raised below the configured threshold.

On the wallboard, the Downloads panel shows the live rate, and failures or low disk space turn the panel red.

Test From The Docker Host

curl -fsSL 'http://downloads.example.lan:8080/api?mode=queue&output=json&apikey=YOUR_API_KEY'

A wrong key answers with an error such as API Key Incorrect. The version endpoint works without a key, so a successful mode=version call only proves the host is reachable, not that the key is right.

Common Problems

  • Rejected API key. Use the full API Key, not the NZB Key, and watch for a leading or trailing space when pasting.
  • Hostname rejected. If SABnzbd refuses the dashboard's hostname, add it under Config > Special > host_whitelist.
  • Wrong URL. Use the SABnzbd base URL. If it is served from a sub-path behind a reverse proxy, include the sub-path.
  • Paused queue. A paused queue is shown as paused, not as a warning, because pausing is often deliberate.