Sabnzbd API Integration
Decypharr provides a Sabnzbd-compatible API for Arr applications to submit NZB files.
How It Works
Section titled “How It Works”Arrs send NZB files to Decypharr’s /sabnzbd/api endpoint. Decypharr:
- Receives NZB file
- Processes with Usenet providers
- Streams/downloads content
- Reports status back to Arr
Configuration in Arrs
Section titled “Configuration in Arrs”Sonarr/Radarr
Section titled “Sonarr/Radarr”Settings → Download Clients → + → Sabnzbd
Screenshot: Sabnzbd download client setup.
| Field | Value |
|---|---|
| Name | Decypharr Usenet |
| Host | decypharr (or IP) |
| Port | 8282 |
| URL Base | /sabnzbd |
| Username | Arr’s host(http://sonarr:8989) |
| Password | Arr’s token(gotten from Arr’s General -> Token) |
| Category | sonarr / radarr |
Click Test → Save
API Endpoints
Section titled “API Endpoints”Decypharr implements these Sabnzbd API endpoints:
| Endpoint | Purpose |
|---|---|
/sabnzbd/api?mode=addfile | Add NZB file |
/sabnzbd/api?mode=queue | Get queue status |
/sabnzbd/api?mode=history | Get download history |
/sabnzbd/api?mode=config | Get configuration |
/sabnzbd/api?mode=delete | Remove from queue |
Categories
Section titled “Categories”Categories organize downloads:
/mnt/decypharr/├── sonarr/├── radarr/├── lidarr/└── custom/Set in Arr’s download client config.
Status Mapping
Section titled “Status Mapping”Decypharr translates NZB processing status to Sabnzbd equivalents:
| Decypharr | Sabnzbd | Meaning |
|---|---|---|
| Processing | Downloading | NZB being processed |
| Streaming | Downloading | File accessible |
| Completed | Completed | Download finished |
| Failed | Failed | Error occurred |
NZBs Not Processing
Section titled “NZBs Not Processing”- Verify Usenet providers configured: Usenet Setup
- Check logs for connection errors
- Ensure provider has retention for the NZB
Arr Shows “Unknown” Status
Section titled “Arr Shows “Unknown” Status”Decypharr may still be processing. Wait 1-2 minutes and refresh.
Path Not Found
Section titled “Path Not Found”Ensure mount path matches between Decypharr and Arr:
Docker Example:
services: decypharr: volumes: - /mnt/media:/mnt/media
sonarr: volumes: - /mnt/media:/mnt/mediaThen use anime or 4k as category in Arr.
Comparison to Native Sabnzbd
Section titled “Comparison to Native Sabnzbd”| Feature | Decypharr | Sabnzbd |
|---|---|---|
| NZB Processing | Direct NNTP streaming | Download + Extract |
| Disk Usage | Minimal (streaming) | Full file size |
| Speed | Instant start | Wait for complete download |
| PAR2 Repair | NA | Built-in |
| Post-Processing | Via Arr | Built-in scripts |
Decypharr is optimized for streaming; Sabnzbd for complete downloads.
Switching from Sabnzbd
Section titled “Switching from Sabnzbd”- Add Decypharr as new download client in Arr
- Set higher priority than Sabnzbd
- Test with new downloads
- Once stable, remove Sabnzbd client
- Optionally disable Sabnzbd container