Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Indexer Torznab caps endpoint

  • Status: Accepted
  • Date: 2026-02-03
  • Context:
    • We need to begin Torznab API parity by serving a caps response backed by seeded categories.
    • Authentication must use the Torznab API key query parameter and reject disabled/deleted instances.
    • Runtime SQL must remain stored-procedure-only and error messages must be constant.
  • Decision:
    • Add stored procedures to authenticate Torznab instances and list seeded Torznab categories.
    • Expose a Torznab caps handler that authenticates via apikey and returns XML caps data.
    • Keep invalid/unsupported Torznab requests as empty XML responses with no DB writes.
  • Consequences:
    • Positive outcomes:
      • Arr clients can validate Torznab connectivity via caps using live category data.
      • Authentication and category access stay consistent with stored-proc-only policy.
    • Risks or trade-offs:
      • Only caps is implemented so far; search and download endpoints still require follow-on work.
  • Follow-up:
    • Implement Torznab search and download endpoints with full ERD semantics.
    • Add additional Torznab response tests and OpenAPI parity updates as functionality expands.