@ctrl/qbittorrent
    Preparing search index...

    Interface AddMagnetOptions

    interface AddMagnetOptions {
        category: string;
        cookie: string;
        dlLimit: number;
        downloader: string;
        filePriorities: string | TorrentFilePriority[];
        firstLastPiecePrio: TrueFalseStr;
        paused?: TrueFalseStr;
        rename: string;
        root_folder: TrueFalseStr;
        savepath: string;
        sequentialDownload: TrueFalseStr;
        skip_checking: TrueFalseStr;
        stopped?: TrueFalseStr;
        tags: string;
        upLimit: number;
        useAutoTMM: TrueFalseStr;
    }
    Index

    Properties

    category cookie dlLimit downloader filePriorities firstLastPiecePrio paused? rename root_folder savepath sequentialDownload skip_checking stopped? tags upLimit useAutoTMM

    Properties

    category: string

    Category for the torrent

    cookie: string
    dlLimit: number

    Set torrent download speed limit. Unit in bytes/second

    downloader: string

    Search plugin used to download the torrent. Added to /torrents/add in qBittorrent WebUI API v2.13.1 https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2131

    filePriorities: string | TorrentFilePriority[]

    File priorities when adding a single torrent from previously fetched or parsed metadata. Added in qBittorrent WebUI API v2.11.9 https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2119

    firstLastPiecePrio: TrueFalseStr

    Prioritize download first last piece. Possible values are true, false (default)

    paused?: TrueFalseStr

    Add torrents in the paused state. Possible values are true, false (default)

    rename: string

    Rename torrent

    root_folder: TrueFalseStr

    Create the root folder. Possible values are true, false, unset (default)

    savepath: string
    sequentialDownload: TrueFalseStr

    Enable sequential download. Possible values are true, false (default)

    skip_checking: TrueFalseStr

    Skip hash checking. Possible values are true, false (default)

    stopped?: TrueFalseStr
    tags: string

    Tags for the torrent, split by ','

    upLimit: number

    Set torrent upload speed limit. Unit in bytes/second

    useAutoTMM: TrueFalseStr

    Whether Automatic Torrent Management should be used, disables use of savepath

    Settings

    Member Visibility

    On This Page

    Properties