Sabnzbd
@kitquiet/sabnzbdv2026.07.23.1
01README
Category CRUD, queue/history visibility, and NZB-by-URL submission for SABnzbd via its REST API, with the API key resolved from a vault at execution time instead of passed as a literal.
02Models
@kitquiet/sabnzbdv2026.07.23.1sabnzbd.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| baseUrl | string | SABnzbd base URL, e.g. http://sabnzbd:8080 (no url_base prefix — |
| apiKey | string | SABnzbd API key. Supply via a vault expression |
fn list_categories()
List all configured SABnzbd categories
fn add_category(name: string, priority: number)
Create a SABnzbd category (idempotent: no-op if it already exists)
| Argument | Type | Description |
|---|---|---|
| name | string | Category name |
| priority | number | Queue priority for this category |
fn remove_category(name: string)
Remove a SABnzbd category (succeeds if already gone)
| Argument | Type | Description |
|---|---|---|
| name | string | Category name to remove |
fn get_queue()
Snapshot SABnzbd's current download queue
fn get_history(limit: number)
Fetch recent SABnzbd history entries (completed and failed)
| Argument | Type | Description |
|---|---|---|
| limit | number | Maximum number of entries |
fn add_nzb_url(url: string, name?: string, category?: string)
Add an NZB to the queue by URL
| Argument | Type | Description |
|---|---|---|
| url | string | URL SABnzbd should fetch the .nzb from |
| name? | string | Optional display name for the job |
| category? | string | Optional category to assign |
Resources
category(infinite)— A configured SABnzbd category
queue(1h)— SABnzbd's current download queue snapshot
history_entry(7d)— A single SABnzbd history entry (completed or failed)
03Stats
A
100 / 100
Downloads
2
Archive size
7.5 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
04Platforms