API Server Documentation

NZB Flow includes an optional web API for remote control and automation. Enable it in Settings → Automation to access queue management, approval workflows, and status monitoring.

Quick Start

Enable API: Settings → Automation → Enable API Server
Configure: Set custom port and authentication credentials
Test: Download the Postman collection below

📦 Postman Collection

Download API Collection

The collection includes comprehensive documentation for each endpoint with example requests and responses.

Configuration

Setting	Description	Default
Port	API server port	`3000`
Authentication	Enable/disable API key authentication	Enabled
API Key	Custom authentication token	Auto-generated

Data Structures

TaskConfig & TaskSettings

The API uses two main data structures for managing tasks:

TaskSettings

Profile-related configuration that can be modified via API:

All profile settings (compression, encryption, server details)
Stored in JSON format for easy manipulation
Can be extracted from saved profile files

💡 Tip: Open any profile JSON file to see the complete TaskSettings structure

TaskConfig

Generated task information based on TaskSettings:

Task name and paths (NZB, RAR/PAR folders)
Computed values from profile settings
Auto-regenerates dependent paths when name changes

Dynamic Regeneration

Random Name/Password Reset

To regenerate random values based on current settings:

{
  "name": "",
  "password": ""
}

Setting these fields to empty strings triggers automatic regeneration using the profile’s randomization rules.

API Endpoints

📦 Complete Documentation: All endpoints, parameters, and examples are included in the Postman collection.

Key Endpoint Categories

Queue Management: Control compression and upload queues
Task Operations: Create, modify, and monitor individual tasks
Approval Workflow: Manage task approval system
Status Monitoring: Real-time queue and task status
Profile Management: CRUD operations for posting profiles

Authentication

All API requests require authentication via header:

Authorization: Bearer YOUR_API_KEY

The API key can be found and regenerated in Settings → Automation → API Key.