Skip to content

Sabnzbd API Integration

Decypharr provides a Sabnzbd-compatible API for Arr applications to submit NZB files.

Arrs send NZB files to Decypharr’s /sabnzbd/api endpoint. Decypharr:

  1. Receives NZB file
  2. Processes with Usenet providers
  3. Streams/downloads content
  4. Reports status back to Arr

SettingsDownload Clients+Sabnzbd

Sabnzbd download client setup in Arr

Screenshot: Sabnzbd download client setup.

FieldValue
NameDecypharr Usenet
Hostdecypharr (or IP)
Port8282
URL Base/sabnzbd
UsernameArr’s host(http://sonarr:8989)
PasswordArr’s token(gotten from Arr’s General -> Token)
Categorysonarr / radarr

Click TestSave

Decypharr implements these Sabnzbd API endpoints:

EndpointPurpose
/sabnzbd/api?mode=addfileAdd NZB file
/sabnzbd/api?mode=queueGet queue status
/sabnzbd/api?mode=historyGet download history
/sabnzbd/api?mode=configGet configuration
/sabnzbd/api?mode=deleteRemove from queue

Categories organize downloads:

/mnt/decypharr/
├── sonarr/
├── radarr/
├── lidarr/
└── custom/

Set in Arr’s download client config.

Decypharr translates NZB processing status to Sabnzbd equivalents:

DecypharrSabnzbdMeaning
ProcessingDownloadingNZB being processed
StreamingDownloadingFile accessible
CompletedCompletedDownload finished
FailedFailedError occurred
  1. Verify Usenet providers configured: Usenet Setup
  2. Check logs for connection errors
  3. Ensure provider has retention for the NZB

Decypharr may still be processing. Wait 1-2 minutes and refresh.

Ensure mount path matches between Decypharr and Arr:

Docker Example:

services:
decypharr:
volumes:
- /mnt/media:/mnt/media
sonarr:
volumes:
- /mnt/media:/mnt/media

Then use anime or 4k as category in Arr.

FeatureDecypharrSabnzbd
NZB ProcessingDirect NNTP streamingDownload + Extract
Disk UsageMinimal (streaming)Full file size
SpeedInstant startWait for complete download
PAR2 RepairNABuilt-in
Post-ProcessingVia ArrBuilt-in scripts

Decypharr is optimized for streaming; Sabnzbd for complete downloads.

  1. Add Decypharr as new download client in Arr
  2. Set higher priority than Sabnzbd
  3. Test with new downloads
  4. Once stable, remove Sabnzbd client
  5. Optionally disable Sabnzbd container