@ctrl/qbittorrent
    Preparing search index...

    Interface QBittorrentConfig

    interface QBittorrentConfig {
        apiKey?: string;
        baseUrl: string;
        dispatcher?: any;
        password?: string;
        path?: string;
        timeout?: number;
        username?: string;
    }

    Hierarchy

    • TorrentClientConfig
      • QBittorrentConfig
    Index

    Properties

    apiKey? baseUrl dispatcher? password? path? timeout? username?

    Properties

    apiKey?: string

    qBittorrent WebAPI key. Added in qBittorrent v5.2.0. When set, the client uses Authorization: Bearer <apiKey> instead of cookie login. https://github.com/qbittorrent/qBittorrent/wiki/API-Key-Authentication-%28%E2%89%A5v5.2.0%29

    baseUrl: string

    ex - `http://localhost:4444/

    dispatcher?: any

    Pass proxy agent to ofetch Only supported in Node.js >= 18 using undici

    https://undici.nodejs.org/#/docs/api/Dispatcher

    https://github.com/unjs/ofetch#️-adding-https-agent

    password?: string
    path?: string

    ex - '/json'

    timeout?: number

    global request timeout

    https://github.com/unjs/ofetch#️-timeout

    username?: string

    Settings

    Member Visibility

    On This Page

    Properties