Skip to content
Weaver Docs

Automation And Integration

Most jobs arrive without anyone clicking Upload. These terms cover the ways in, the ways other tools talk to Weaver, and the state that travels between instances.

RSS Feed

Section titled “RSS Feed”

An RSS feed is a feed URL Weaver polls, with optional basic auth, a poll interval, a default category, and default metadata. Feeds live in Settings → RSS. The poll loop ticks every minute and polls a feed when its interval has elapsed, 15 minutes by default.

RSS Rule

Section titled “RSS Rule”

An RSS rule is an ordered accept or reject policy on a feed. It can match a title regex, feed categories, and a size range, and an accept rule can override the category and add metadata. Rules are evaluated in sort order and the first match wins. A feed with no accept rule submits nothing.

Seen History

Section titled “Seen History”

Seen history records each feed item’s decision: accepted, submitted, rejected, ignored, or error. Weaver keeps it for 180 days. Clearing it lets the feed reconsider items it already saw.

Watch Folder

Section titled “Watch Folder”

The watch folder imports NZBs and supported archives dropped into a local folder, in Settings → Watch Folder. Modes are off, polling on an interval, or realtime watching. Immediate subfolders can map to existing categories. Processed inputs are renamed with a marker suffix such as .queued or .error so nothing is imported twice.

API Key

Section titled “API Key”

An API key is a credential for integrations, created in Settings → Security with one of three scopes. Read can query state. Control the queue can submit and control jobs. Admin can change settings and delete history. Keys are shown once at creation.

GraphQL API

Section titled “GraphQL API”

The GraphQL API at /graphql, with subscriptions at /graphql/ws, is what the web UI itself uses. Integrations authenticate with an API key.

NZBGet-Compatible API

Section titled “NZBGet-Compatible API”

The NZBGet-compatible API at /jsonrpc and /xmlrpc lets Scryer, Sonarr, Radarr, nzb360, and other NZBGet clients use Weaver unchanged. The client’s password field carries a Weaver API key. See API And Metrics.

Metrics Endpoint

Section titled “Metrics Endpoint”

The metrics endpoint at /metrics exposes Prometheus metrics. It requires a read API key unless WEAVER_METRICS_AUTH_REQUIRED=0.

Backup

Section titled “Backup”

A backup is a downloadable bundle of stable state: settings, servers, categories, API keys, RSS state, security settings, and history. It never includes active jobs or downloaded files, and it can be password protected.

Restore

Section titled “Restore”

Restore analyzes a backup, asks for new directories and any category remaps the new host needs, then stages the state and applies it on the next restart. See Backup And Restore.

Base URL

Section titled “Base URL”

The base URL is the path prefix Weaver serves under behind a reverse proxy, set with --base-url. Assets, routes, GraphQL, and WebSockets all follow it.

Section titled “Related”