@ctrl/qbittorrent
    Preparing search index...

    Interface Preferences

    interface Preferences {
        add_stopped_enabled?: boolean;
        add_to_top_of_queue?: boolean;
        add_trackers: string;
        add_trackers_enabled: boolean;
        add_trackers_from_url_enabled?: boolean;
        add_trackers_url?: string;
        add_trackers_url_list?: string;
        alt_dl_limit: number;
        alt_up_limit: number;
        alternative_webui_enabled: boolean;
        alternative_webui_path: string;
        announce_ip: string;
        announce_port?: number;
        announce_to_all_tiers: boolean;
        announce_to_all_trackers: boolean;
        anonymous_mode: boolean;
        app_instance_name?: string;
        async_io_threads: number;
        auto_delete_mode: number;
        auto_tmm_enabled: boolean;
        autorun_enabled: boolean;
        autorun_on_torrent_added_enabled?: boolean;
        autorun_on_torrent_added_program?: string;
        autorun_program: string;
        banned_IPs: string;
        bdecode_depth_limit?: number;
        bdecode_token_limit?: number;
        bittorrent_protocol: 0 | 1 | 2;
        block_peers_on_privileged_ports?: boolean;
        bypass_auth_subnet_whitelist: string;
        bypass_auth_subnet_whitelist_enabled: boolean;
        bypass_local_auth: boolean;
        category_changed_tmm_enabled: boolean;
        checking_memory_use: number;
        confirm_remove_all_tags?: boolean;
        confirm_remove_tracker_from_all_torrents?: boolean;
        confirm_torrent_deletion?: boolean;
        confirm_torrent_recheck?: boolean;
        connection_speed?: number;
        create_subfolder_enabled: boolean;
        current_interface_address: string;
        current_interface_name?: string;
        current_network_interface: string;
        delete_torrent_content_files?: boolean;
        dht: boolean;
        dht_bootstrap_nodes?: string;
        disk_cache: number;
        disk_cache_ttl: number;
        disk_io_read_mode?: number;
        disk_io_type?: number;
        disk_io_write_mode?: number;
        disk_queue_size?: number;
        dl_limit: number;
        dont_count_slow_torrents: boolean;
        dyndns_domain: string;
        dyndns_enabled: boolean;
        dyndns_password: string;
        dyndns_service: number;
        dyndns_username: string;
        embedded_tracker_port: number;
        embedded_tracker_port_forwarding?: boolean;
        enable_coalesce_read_write: boolean;
        enable_embedded_tracker: boolean;
        enable_multi_connections_from_same_ip: boolean;
        enable_multi_connections_from_same_peer_id?: boolean;
        enable_os_cache: boolean;
        enable_piece_extent_affinity: boolean;
        enable_upload_suggestions: boolean;
        encryption: 0 | 1 | 2;
        excluded_file_names?: string;
        excluded_file_names_enabled?: boolean;
        export_dir?: string;
        export_dir_fin?: string;
        file_log_age?: number;
        file_log_age_type?: number;
        file_log_backup_enabled?: boolean;
        file_log_delete_old?: boolean;
        file_log_enabled?: boolean;
        file_log_max_size?: number;
        file_log_path?: string;
        file_pool_size: number;
        hashing_threads?: number;
        hostname_cache_ttl?: number;
        i2p_address?: string;
        i2p_enabled?: boolean;
        i2p_inbound_length?: number;
        i2p_inbound_length_variance?: number;
        i2p_inbound_quantity?: number;
        i2p_mixed_mode?: boolean;
        i2p_outbound_length?: number;
        i2p_outbound_length_variance?: number;
        i2p_outbound_quantity?: number;
        i2p_pex_enabled?: boolean;
        i2p_port?: number;
        idn_support_enabled?: boolean;
        ignore_ssl_errors?: boolean;
        incomplete_files_ext: boolean;
        ip_filter_enabled: boolean;
        ip_filter_path: string;
        ip_filter_trackers: boolean;
        limit_lan_peers: boolean;
        limit_tcp_overhead: boolean;
        limit_utp_rate: boolean;
        listen_port: number;
        locale: string;
        lsd: boolean;
        mail_notification_auth_enabled: boolean;
        mail_notification_email: string;
        mail_notification_enabled: boolean;
        mail_notification_encryption_type?: string;
        mail_notification_password: string;
        mail_notification_sender: string;
        mail_notification_smtp: string;
        mail_notification_ssl_enabled?: boolean;
        mail_notification_username: string;
        mark_of_the_web?: boolean;
        max_active_checking_torrents?: number;
        max_active_downloads: number;
        max_active_torrents: number;
        max_active_uploads: number;
        max_concurrent_http_announces?: number;
        max_connec: number;
        max_connec_per_torrent: number;
        max_inactive_seeding_time?: number;
        max_inactive_seeding_time_enabled?: boolean;
        max_outstanding_block_requests?: number;
        max_ratio: number;
        max_ratio_act: boolean;
        max_ratio_enabled: boolean;
        max_seeding_time: number;
        max_seeding_time_enabled: boolean;
        max_uploads: number;
        max_uploads_per_torrent: number;
        memory_working_set_limit?: number;
        merge_trackers?: boolean;
        outgoing_ports_max: number;
        outgoing_ports_min: number;
        peer_tos?: number;
        peer_turnover?: number;
        peer_turnover_cutoff?: number;
        peer_turnover_interval?: number;
        performance_warning?: boolean;
        pex: boolean;
        preallocate_all: boolean;
        proxy_auth_enabled: boolean;
        proxy_bittorrent?: boolean;
        proxy_hostname_lookup?: boolean;
        proxy_ip: string;
        proxy_misc?: boolean;
        proxy_password: string;
        proxy_peer_connections: boolean;
        proxy_port: number;
        proxy_rss?: boolean;
        proxy_torrents_only: boolean;
        proxy_type: number;
        proxy_username: string;
        python_executable_path?: string;
        queueing_enabled: boolean;
        random_port: boolean;
        reannounce_when_address_changed?: boolean;
        recheck_completed_torrents: boolean;
        refresh_interval?: number;
        remove_torrent_file_backup?: boolean;
        request_queue_size?: number;
        resolve_peer_countries: boolean;
        resolve_peer_host_names?: boolean;
        resume_data_storage_type?: "Legacy" | "SQLite";
        rss_auto_downloading_enabled: boolean;
        rss_download_repack_proper_episodes: boolean;
        rss_fetch_delay?: number;
        rss_max_articles_per_feed: number;
        rss_processing_enabled: boolean;
        rss_refresh_interval: number;
        rss_smart_episode_filters: string;
        save_path: string;
        save_path_changed_tmm_enabled: boolean;
        save_resume_data_interval: number;
        save_statistics_interval?: number;
        scan_dirs: Record<string, 0 | 1 | string>;
        schedule_from_hour: number;
        schedule_from_min: number;
        schedule_to_hour: number;
        schedule_to_min: number;
        scheduler_days: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
        scheduler_enabled: boolean;
        seeding_outgoing_connections?: boolean;
        send_buffer_low_watermark: number;
        send_buffer_watermark: number;
        send_buffer_watermark_factor: number;
        share_limits_mode?: string;
        shutdown_timeout?: number;
        slow_torrent_dl_rate_threshold: number;
        slow_torrent_inactive_timer: number;
        slow_torrent_ul_rate_threshold: number;
        socket_backlog_size: number;
        socket_receive_buffer_size?: number;
        socket_send_buffer_size?: number;
        ssl_cert: string;
        ssl_enabled?: boolean;
        ssl_key: string;
        ssl_listen_port?: number;
        ssrf_mitigation?: boolean;
        start_paused?: boolean;
        start_paused_enabled: boolean;
        status_bar_external_ip?: boolean;
        stop_tracker_timeout: number;
        store_search_job_results?: boolean;
        store_search_jobs?: boolean;
        temp_path: string;
        temp_path_enabled: boolean;
        torrent_changed_tmm_enabled: boolean;
        torrent_content_layout?: "Original" | "Subfolder" | "NoSubfolder";
        torrent_content_remove_option?: "Delete" | "MoveToTrash";
        torrent_file_size_limit?: number;
        torrent_files_backup_dir?: string;
        torrent_files_backup_enabled?: boolean;
        torrent_files_finished_backup_dir?: string;
        torrent_files_finished_backup_dir_enabled?: boolean;
        torrent_stop_condition?: "None" | "MetadataReceived" | "FilesChecked";
        up_limit: number;
        upload_choking_algorithm: number;
        upload_slots_behavior: number;
        upnp: boolean;
        upnp_lease_duration: number;
        use_category_paths_in_manual_mode?: boolean;
        use_https: boolean;
        use_subcategories?: boolean;
        use_unwanted_folder?: boolean;
        utp_tcp_mixed_mode: number;
        validate_https_tracker_certificate?: boolean;
        web_ui_address: string;
        web_ui_api_key?: string;
        web_ui_ban_duration: number;
        web_ui_clickjacking_protection_enabled: boolean;
        web_ui_csrf_protection_enabled: boolean;
        web_ui_custom_http_headers: string;
        web_ui_domain_list: string;
        web_ui_host_header_validation_enabled: boolean;
        web_ui_https_cert_path: string;
        web_ui_https_key_path: string;
        web_ui_max_auth_fail_count: number;
        web_ui_password?: string;
        web_ui_port: number;
        web_ui_reverse_proxies_list?: string;
        web_ui_reverse_proxy_enabled?: boolean;
        web_ui_secure_cookie_enabled: boolean;
        web_ui_session_timeout: number;
        web_ui_sessions_count_limit?: number;
        web_ui_upnp: boolean;
        web_ui_use_custom_http_headers_enabled: boolean;
        web_ui_username: string;
        webtorrent_stun_server?: string;
    }
    Index
    add_stopped_enabled? add_to_top_of_queue? add_trackers add_trackers_enabled add_trackers_from_url_enabled? add_trackers_url? add_trackers_url_list? alt_dl_limit alt_up_limit alternative_webui_enabled alternative_webui_path announce_ip announce_port? announce_to_all_tiers announce_to_all_trackers anonymous_mode app_instance_name? async_io_threads auto_delete_mode auto_tmm_enabled autorun_enabled autorun_on_torrent_added_enabled? autorun_on_torrent_added_program? autorun_program banned_IPs bdecode_depth_limit? bdecode_token_limit? bittorrent_protocol block_peers_on_privileged_ports? bypass_auth_subnet_whitelist bypass_auth_subnet_whitelist_enabled bypass_local_auth category_changed_tmm_enabled checking_memory_use confirm_remove_all_tags? confirm_remove_tracker_from_all_torrents? confirm_torrent_deletion? confirm_torrent_recheck? connection_speed? create_subfolder_enabled current_interface_address current_interface_name? current_network_interface delete_torrent_content_files? dht dht_bootstrap_nodes? disk_cache disk_cache_ttl disk_io_read_mode? disk_io_type? disk_io_write_mode? disk_queue_size? dl_limit dont_count_slow_torrents dyndns_domain dyndns_enabled dyndns_password dyndns_service dyndns_username embedded_tracker_port embedded_tracker_port_forwarding? enable_coalesce_read_write enable_embedded_tracker enable_multi_connections_from_same_ip enable_multi_connections_from_same_peer_id? enable_os_cache enable_piece_extent_affinity enable_upload_suggestions encryption excluded_file_names? excluded_file_names_enabled? export_dir? export_dir_fin? file_log_age? file_log_age_type? file_log_backup_enabled? file_log_delete_old? file_log_enabled? file_log_max_size? file_log_path? file_pool_size hashing_threads? hostname_cache_ttl? i2p_address? i2p_enabled? i2p_inbound_length? i2p_inbound_length_variance? i2p_inbound_quantity? i2p_mixed_mode? i2p_outbound_length? i2p_outbound_length_variance? i2p_outbound_quantity? i2p_pex_enabled? i2p_port? idn_support_enabled? ignore_ssl_errors? incomplete_files_ext ip_filter_enabled ip_filter_path ip_filter_trackers limit_lan_peers limit_tcp_overhead limit_utp_rate listen_port locale lsd mail_notification_auth_enabled mail_notification_email mail_notification_enabled mail_notification_encryption_type? mail_notification_password mail_notification_sender mail_notification_smtp mail_notification_ssl_enabled? mail_notification_username mark_of_the_web? max_active_checking_torrents? max_active_downloads max_active_torrents max_active_uploads max_concurrent_http_announces? max_connec max_connec_per_torrent max_inactive_seeding_time? max_inactive_seeding_time_enabled? max_outstanding_block_requests? max_ratio max_ratio_act max_ratio_enabled max_seeding_time max_seeding_time_enabled max_uploads max_uploads_per_torrent memory_working_set_limit? merge_trackers? outgoing_ports_max outgoing_ports_min peer_tos? peer_turnover? peer_turnover_cutoff? peer_turnover_interval? performance_warning? pex preallocate_all proxy_auth_enabled proxy_bittorrent? proxy_hostname_lookup? proxy_ip proxy_misc? proxy_password proxy_peer_connections proxy_port proxy_rss? proxy_torrents_only proxy_type proxy_username python_executable_path? queueing_enabled random_port reannounce_when_address_changed? recheck_completed_torrents refresh_interval? remove_torrent_file_backup? request_queue_size? resolve_peer_countries resolve_peer_host_names? resume_data_storage_type? rss_auto_downloading_enabled rss_download_repack_proper_episodes rss_fetch_delay? rss_max_articles_per_feed rss_processing_enabled rss_refresh_interval rss_smart_episode_filters save_path save_path_changed_tmm_enabled save_resume_data_interval save_statistics_interval? scan_dirs schedule_from_hour schedule_from_min schedule_to_hour schedule_to_min scheduler_days scheduler_enabled seeding_outgoing_connections? send_buffer_low_watermark send_buffer_watermark send_buffer_watermark_factor share_limits_mode? shutdown_timeout? slow_torrent_dl_rate_threshold slow_torrent_inactive_timer slow_torrent_ul_rate_threshold socket_backlog_size socket_receive_buffer_size? socket_send_buffer_size? ssl_cert ssl_enabled? ssl_key ssl_listen_port? ssrf_mitigation? start_paused? start_paused_enabled status_bar_external_ip? stop_tracker_timeout store_search_job_results? store_search_jobs? temp_path temp_path_enabled torrent_changed_tmm_enabled torrent_content_layout? torrent_content_remove_option? torrent_file_size_limit? torrent_files_backup_dir? torrent_files_backup_enabled? torrent_files_finished_backup_dir? torrent_files_finished_backup_dir_enabled? torrent_stop_condition? up_limit upload_choking_algorithm upload_slots_behavior upnp upnp_lease_duration use_category_paths_in_manual_mode? use_https use_subcategories? use_unwanted_folder? utp_tcp_mixed_mode validate_https_tracker_certificate? web_ui_address web_ui_api_key? web_ui_ban_duration web_ui_clickjacking_protection_enabled web_ui_csrf_protection_enabled web_ui_custom_http_headers web_ui_domain_list web_ui_host_header_validation_enabled web_ui_https_cert_path web_ui_https_key_path web_ui_max_auth_fail_count web_ui_password? web_ui_port web_ui_reverse_proxies_list? web_ui_reverse_proxy_enabled? web_ui_secure_cookie_enabled web_ui_session_timeout web_ui_sessions_count_limit? web_ui_upnp web_ui_use_custom_http_headers_enabled web_ui_username webtorrent_stun_server?
    add_stopped_enabled?: boolean
    add_to_top_of_queue?: boolean
    add_trackers: string

    List of trackers to add to new torrent

    add_trackers_enabled: boolean

    Enable automatic adding of trackers to new torrents

    add_trackers_from_url_enabled?: boolean
    add_trackers_url?: string
    add_trackers_url_list?: string
    alt_dl_limit: number

    Alternative global download speed limit in KiB/s

    alt_up_limit: number

    Alternative global upload speed limit in KiB/s

    alternative_webui_enabled: boolean

    True if an alternative WebUI should be used

    alternative_webui_path: string

    File path to the alternative WebUI

    announce_ip: string

    TODO

    announce_port?: number
    announce_to_all_tiers: boolean

    True always announce to all tiers

    announce_to_all_trackers: boolean

    True always announce to all trackers in a tier

    anonymous_mode: boolean

    If true anonymous mode will be enabled; read more here; this option is only available in qBittorent built against libtorrent version 0.16.X and higher

    app_instance_name?: string
    async_io_threads: number

    Number of asynchronous I/O threads

    auto_delete_mode: number

    TODO

    auto_tmm_enabled: boolean

    True if Automatic Torrent Management is enabled by default

    autorun_enabled: boolean

    True if external program should be run after torrent has finished downloading

    autorun_on_torrent_added_enabled?: boolean
    autorun_on_torrent_added_program?: string
    autorun_program: string

    Program path/name/arguments to run if autorun_enabled is enabled; path is separated by slashes; you can use %f and %n arguments, which will be expanded by qBittorent as path_to_torrent_file and torrent_name (from the GUI; not the .torrent file name) respectively

    banned_IPs: string

    List of banned IPs

    bdecode_depth_limit?: number
    bdecode_token_limit?: number
    bittorrent_protocol: 0 | 1 | 2

    Bittorrent Protocol to use 0 TCP and μTP 1 TCP 2 μTP

    block_peers_on_privileged_ports?: boolean
    bypass_auth_subnet_whitelist: string

    (White)list of ipv4/ipv6 subnets for which webui authentication should be bypassed; list entries are separated by commas

    bypass_auth_subnet_whitelist_enabled: boolean

    True if webui authentication should be bypassed for clients whose ip resides within (at least) one of the subnets on the whitelist

    bypass_local_auth: boolean

    True if authentication challenge for loopback address (127.0.0.1) should be disabled

    category_changed_tmm_enabled: boolean

    True if torrent should be relocated when its Category's save path changes

    checking_memory_use: number

    Outstanding memory when checking torrents in MiB

    confirm_remove_all_tags?: boolean

    WebAPI 2.16.2+

    confirm_remove_tracker_from_all_torrents?: boolean

    WebAPI 2.16.2+

    confirm_torrent_deletion?: boolean
    confirm_torrent_recheck?: boolean
    connection_speed?: number
    create_subfolder_enabled: boolean

    True if a subfolder should be created when adding a torrent

    replaced by torrent_content_layout

    current_interface_address: string

    IP Address to bind to. Empty String means All addresses

    current_interface_name?: string
    current_network_interface: string

    Network Interface used

    Optionaldelete_torrent_content_files

    delete_torrent_content_files?: boolean
    dht: boolean

    True if DHT is enabled

    dht_bootstrap_nodes?: string
    disk_cache: number

    Disk cache used in MiB

    disk_cache_ttl: number

    Disk cache expiry interval in seconds

    disk_io_read_mode?: number
    disk_io_type?: number
    disk_io_write_mode?: number
    disk_queue_size?: number
    dl_limit: number

    Global download speed limit in KiB/s; -1 means no limit is applied

    dont_count_slow_torrents: boolean

    If true torrents w/o any activity (stalled ones) will not be counted towards max_active_* limits; see dont_count_slow_torrents for more information

    dyndns_domain: string

    Your DDNS domain name

    dyndns_enabled: boolean

    True if server DNS should be updated dynamically

    dyndns_password: string

    Password for DDNS service

    dyndns_service: number

    See list of possible values here below

    dyndns_username: string

    Username for DDNS service

    embedded_tracker_port: number

    Port used for embedded tracker

    embedded_tracker_port_forwarding?: boolean
    enable_coalesce_read_write: boolean

    True enables coalesce reads & writes

    enable_embedded_tracker: boolean

    True enables embedded tracker

    enable_multi_connections_from_same_ip: boolean

    True allows multiple connections from the same IP address

    enable_multi_connections_from_same_peer_id?: boolean

    Allow multiple connections from the same peer ID. Added in WebAPI v2.16.0.

    enable_os_cache: boolean

    True enables os cache

    not returned by qBittorrent 5.x

    enable_piece_extent_affinity: boolean

    True if the advanced libtorrent option piece_extent_affinity is enabled

    enable_upload_suggestions: boolean

    True enables sending of upload piece suggestions

    encryption: 0 | 1 | 2

    See list of possible values here below 0 Prefer encryption 1 Force encryption on 2 Force encryption off

    excluded_file_names?: string
    excluded_file_names_enabled?: boolean
    export_dir?: string

    Path to directory to copy .torrent files to. Slashes are used as path separators

    removed in WebAPI 2.16, use torrent_files_backup_dir

    export_dir_fin?: string

    Path to directory to copy .torrent files of completed downloads to. Slashes are used as path separators

    removed in WebAPI 2.16, use torrent_files_finished_backup_dir

    file_log_age?: number
    file_log_age_type?: number
    file_log_backup_enabled?: boolean
    file_log_delete_old?: boolean
    file_log_enabled?: boolean
    file_log_max_size?: number
    file_log_path?: string
    file_pool_size: number

    File pool size

    hashing_threads?: number
    hostname_cache_ttl?: number

    Hostname resolver cache expiry interval in seconds Added in qBittorrent v5.2.0

    i2p_address?: string
    i2p_enabled?: boolean
    i2p_inbound_length?: number
    i2p_inbound_length_variance?: number

    WebAPI 2.16.2+

    i2p_inbound_quantity?: number
    i2p_mixed_mode?: boolean
    i2p_outbound_length?: number
    i2p_outbound_length_variance?: number

    WebAPI 2.16.2+

    i2p_outbound_quantity?: number
    i2p_pex_enabled?: boolean

    WebAPI 2.16.2+

    i2p_port?: number
    idn_support_enabled?: boolean
    ignore_ssl_errors?: boolean
    incomplete_files_ext: boolean

    True if ".!qB" should be appended to incomplete files

    ip_filter_enabled: boolean

    True if external IP filter should be enabled

    ip_filter_path: string

    Path to IP filter file (.dat, .p2p, .p2b files are supported); path is separated by slashes

    ip_filter_trackers: boolean

    True if IP filters are applied to trackers

    limit_lan_peers: boolean

    True if [du]l_limit should be applied to peers on the LAN

    limit_tcp_overhead: boolean

    True if [du]l_limit should be applied to estimated TCP overhead (service data: e.g. packet headers)

    limit_utp_rate: boolean

    True if [du]l_limit should be applied to uTP connections; this option is only available in qBittorent built against libtorrent version 0.16.X and higher

    listen_port: number

    Port for incoming connections

    locale: string

    Currently selected language (e.g. en_GB for English)

    lsd: boolean

    True if LSD is enabled

    mail_notification_auth_enabled: boolean

    True if smtp server requires authentication

    mail_notification_email: string

    e-mail to send notifications to

    mail_notification_enabled: boolean

    True if e-mail notification should be enabled

    mail_notification_encryption_type?: string

    SMTP encryption type for e-mail notifications. Added in qBittorrent WebUI API v2.16.0, replacing mail_notification_ssl_enabled. https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2160

    mail_notification_password: string

    Password for smtp authentication

    mail_notification_sender: string

    e-mail where notifications should originate from

    mail_notification_smtp: string

    smtp server for e-mail notifications

    mail_notification_ssl_enabled?: boolean

    True if smtp server requires SSL connection

    removed in WebAPI 2.16, use mail_notification_encryption_type mail_notification_encryption_type instead. https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2160

    mail_notification_username: string

    Username for smtp authentication

    mark_of_the_web?: boolean
    max_active_checking_torrents?: number
    max_active_downloads: number

    Maximum number of active simultaneous downloads

    max_active_torrents: number

    Maximum number of active simultaneous downloads and uploads

    max_active_uploads: number

    Maximum number of active simultaneous uploads

    max_concurrent_http_announces?: number
    max_connec: number

    Maximum global number of simultaneous connections

    max_connec_per_torrent: number

    Maximum number of simultaneous connections per torrent

    max_inactive_seeding_time?: number
    max_inactive_seeding_time_enabled?: boolean
    max_outstanding_block_requests?: number

    Maximum number of outstanding block requests. Added in WebAPI v2.16.0.

    max_ratio: number

    Get the global share ratio limit

    max_ratio_act: boolean

    Action performed when a torrent reaches the maximum share ratio. See list of possible values here below.

    max_ratio_enabled: boolean

    True if share ratio limit is enabled

    max_seeding_time: number

    Number of minutes to seed a torrent

    max_seeding_time_enabled: boolean

    True enables max seeding time

    max_uploads: number

    Maximum number of upload slots

    max_uploads_per_torrent: number

    Maximum number of upload slots per torrent

    memory_working_set_limit?: number
    merge_trackers?: boolean
    outgoing_ports_max: number

    Maximal outgoing port (0: Disabled)

    outgoing_ports_min: number

    Minimal outgoing port (0: Disabled)

    peer_tos?: number
    peer_turnover?: number
    peer_turnover_cutoff?: number
    peer_turnover_interval?: number
    performance_warning?: boolean
    pex: boolean

    True if PeX is enabled

    preallocate_all: boolean

    True if disk space should be pre-allocated for all files

    proxy_auth_enabled: boolean

    True proxy requires authentication; doesn't apply to SOCKS4 proxies

    proxy_bittorrent?: boolean
    proxy_hostname_lookup?: boolean
    proxy_ip: string

    Proxy IP address or domain name

    proxy_misc?: boolean
    proxy_password: string

    Password for proxy authentication

    proxy_peer_connections: boolean

    True if peer and web seed connections should be proxified; this option will have any effect only in qBittorent built against libtorrent version 0.16.X and higher

    proxy_port: number

    Proxy port

    proxy_rss?: boolean
    proxy_torrents_only: boolean

    True if proxy is only used for torrents

    not returned by qBittorrent 5.x

    proxy_type: number

    See list of possible values here below

    proxy_username: string

    Username for proxy authentication

    python_executable_path?: string
    queueing_enabled: boolean

    True if torrent queuing is enabled

    random_port: boolean

    True if the port is randomly selected

    reannounce_when_address_changed?: boolean
    recheck_completed_torrents: boolean

    True rechecks torrents on completion

    refresh_interval?: number
    remove_torrent_file_backup?: boolean

    Remove the .torrent backup when removing a torrent. Added in WebAPI v2.16.0.

    request_queue_size?: number
    resolve_peer_countries: boolean

    True resolves peer countries

    resolve_peer_host_names?: boolean

    True resolves peer host names Added in qBittorrent WebUI API v2.15.1 https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2151

    resume_data_storage_type?: "Legacy" | "SQLite"
    rss_auto_downloading_enabled: boolean

    Enable auto-downloading of torrents from the RSS feeds

    rss_download_repack_proper_episodes: boolean

    For API ≥ v2.5.1: Enable downloading of repack/proper Episodes

    rss_fetch_delay?: number
    rss_max_articles_per_feed: number

    Max stored articles per RSS feed

    rss_processing_enabled: boolean

    Enable processing of RSS feeds

    rss_refresh_interval: number

    RSS refresh interval

    rss_smart_episode_filters: string

    For API ≥ v2.5.1: List of RSS Smart Episode Filters

    save_path: string

    Default save path for torrents, separated by slashes

    save_path_changed_tmm_enabled: boolean

    True if torrent should be relocated when the default save path changes

    save_resume_data_interval: number

    Save resume data interval in min

    save_statistics_interval?: number
    scan_dirs: Record<string, 0 | 1 | string>

    Directory to watch for torrent files, value: where torrents loaded from this directory should be downloaded to (see list of possible values below). Slashes are used as path separators; multiple key/value pairs can be specified Possible values of scan_dirs: 0 Download to the monitored folder 1 Download to the default save path "/path/to/download/to" Download to this path

    schedule_from_hour: number

    Scheduler starting hour

    schedule_from_min: number

    Scheduler starting minute

    schedule_to_hour: number

    Scheduler ending hour

    schedule_to_min: number

    Scheduler ending minute

    scheduler_days: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

    Scheduler days. See possible values here below 0 Every day 1 Every weekday 2 Every weekend 3 Every Monday 4 Every Tuesday 5 Every Wednesday 6 Every Thursday 7 Every Friday 8 Every Saturday 9 Every Sunday

    scheduler_enabled: boolean

    True if alternative limits should be applied according to schedule

    seeding_outgoing_connections?: boolean

    Allow outgoing connections to peers while seeding. Added in qBittorrent WebUI API v2.16.0 https://github.com/qbittorrent/qBittorrent/blob/master/WebAPI_Changelog.md#2160

    send_buffer_low_watermark: number

    Send buffer low watermark in KiB

    send_buffer_watermark: number

    Send buffer watermark in KiB

    send_buffer_watermark_factor: number

    Send buffer watermark factor in percent

    share_limits_mode?: string

    Mode for combining share limits. Added in WebAPI v2.15.3.

    shutdown_timeout?: number

    WebAPI 2.16+

    slow_torrent_dl_rate_threshold: number

    Download rate in KiB/s for a torrent to be considered "slow"

    slow_torrent_inactive_timer: number

    Seconds a torrent should be inactive before considered "slow"

    slow_torrent_ul_rate_threshold: number

    Upload rate in KiB/s for a torrent to be considered "slow"

    socket_backlog_size: number

    Socket backlog size

    socket_receive_buffer_size?: number
    socket_send_buffer_size?: number
    ssl_cert: string

    SSL certificate contents (this is a not a path)

    not returned by qBittorrent 5.x

    ssl_enabled?: boolean
    ssl_key: string

    SSL keyfile contents (this is a not a path)

    not returned by qBittorrent 5.x

    ssl_listen_port?: number
    ssrf_mitigation?: boolean
    start_paused?: boolean

    WebAPI 2.16+

    start_paused_enabled: boolean

    True if torrents should be added in a Paused state

    renamed to add_stopped_enabled in qBittorrent 5.0

    status_bar_external_ip?: boolean
    stop_tracker_timeout: number

    Timeout in seconds for a stopped announce request to trackers

    store_search_job_results?: boolean

    Persist search job results. Added in WebAPI v2.16.1.

    store_search_jobs?: boolean

    Persist search jobs. Added in WebAPI v2.16.1.

    temp_path: string

    Path for incomplete torrents, separated by slashes

    temp_path_enabled: boolean

    True if folder for incomplete torrents is enabled

    torrent_changed_tmm_enabled: boolean

    True if torrent should be relocated when its Category changes

    Optionaltorrent_content_layout

    torrent_content_layout?: "Original" | "Subfolder" | "NoSubfolder"

    Optionaltorrent_content_remove_option

    torrent_content_remove_option?: "Delete" | "MoveToTrash"
    torrent_file_size_limit?: number
    torrent_files_backup_dir?: string

    Directory for .torrent file backups. Added in WebAPI v2.16.0.

    torrent_files_backup_enabled?: boolean

    Save backup copies of .torrent files. Added in WebAPI v2.16.0.

    torrent_files_finished_backup_dir?: string

    Directory for completed torrents’ .torrent backups. Added in WebAPI v2.16.0.

    torrent_files_finished_backup_dir_enabled?: boolean

    Move .torrent backups when downloads finish. Added in WebAPI v2.16.0.

    torrent_stop_condition?: "None" | "MetadataReceived" | "FilesChecked"
    up_limit: number

    Global upload speed limit in KiB/s; -1 means no limit is applied

    upload_choking_algorithm: number

    Upload choking algorithm used (see list of possible values below)

    upload_slots_behavior: number

    Upload slots behavior used (see list of possible values below)

    upnp: boolean

    True if UPnP/NAT-PMP is enabled

    upnp_lease_duration: number

    UPnP lease duration (0: Permanent lease)

    use_category_paths_in_manual_mode?: boolean
    use_https: boolean

    True if WebUI HTTPS access is enabled

    use_subcategories?: boolean

    not returned by qBittorrent 5.2+

    use_unwanted_folder?: boolean
    utp_tcp_mixed_mode: number

    μTP-TCP mixed mode algorithm (see list of possible values below)

    validate_https_tracker_certificate?: boolean
    web_ui_address: string

    IP address to use for the WebUI

    web_ui_api_key?: string

    qBittorrent 5.2+ (WebAPI 2.12+)

    web_ui_ban_duration: number

    WebUI access ban duration in seconds

    web_ui_clickjacking_protection_enabled: boolean

    True if WebUI clickjacking protection is enabled

    web_ui_csrf_protection_enabled: boolean

    True if WebUI CSRF protection is enabled

    web_ui_custom_http_headers: string

    For API ≥ v2.5.1: List of custom http headers

    web_ui_domain_list: string

    Comma-separated list of domains to accept when performing Host header validation

    web_ui_host_header_validation_enabled: boolean

    True if WebUI host header validation is enabled

    web_ui_https_cert_path: string

    For API ≥ v2.0.1: Path to SSL certificate

    web_ui_https_key_path: string

    For API ≥ v2.0.1: Path to SSL keyfile

    web_ui_max_auth_fail_count: number

    Maximum number of authentication failures before WebUI access ban

    web_ui_password?: string

    For API ≥ v2.3.0: Plaintext WebUI password, not readable, write-only. For API < v2.3.0: MD5 hash of WebUI password, hash is generated from the following string: username:Web UI Access:plain_text_web_ui_password Only accepted by setPreferences, never returned

    web_ui_port: number

    WebUI port

    web_ui_reverse_proxies_list?: string
    web_ui_reverse_proxy_enabled?: boolean
    web_ui_secure_cookie_enabled: boolean

    True if WebUI cookie Secure flag is enabled

    web_ui_session_timeout: number

    Seconds until WebUI is automatically signed off

    web_ui_sessions_count_limit?: number

    Maximum number of WebUI sessions. Added in WebAPI v2.16.0.

    web_ui_upnp: boolean

    True if UPnP is used for the WebUI port

    web_ui_use_custom_http_headers_enabled: boolean

    For API ≥ v2.5.1: Enable custom http headers

    web_ui_username: string

    WebUI username

    webtorrent_stun_server?: string

    STUN server for WebTorrent. Added in WebAPI v2.16.1.

    Settings
    Member Visibility

    On This Page
    Properties
    add_stopped_enabledadd_to_top_of_queueadd_trackersadd_trackers_enabledadd_trackers_from_url_enabledadd_trackers_urladd_trackers_url_listalt_dl_limitalt_up_limitalternative_webui_enabledalternative_webui_pathannounce_ipannounce_portannounce_to_all_tiersannounce_to_all_trackersanonymous_modeapp_instance_nameasync_io_threadsauto_delete_modeauto_tmm_enabledautorun_enabledautorun_on_torrent_added_enabledautorun_on_torrent_added_programautorun_programbanned_IPsbdecode_depth_limitbdecode_token_limitbittorrent_protocolblock_peers_on_privileged_portsbypass_auth_subnet_whitelistbypass_auth_subnet_whitelist_enabledbypass_local_authcategory_changed_tmm_enabledchecking_memory_useconfirm_remove_all_tagsconfirm_remove_tracker_from_all_torrentsconfirm_torrent_deletionconfirm_torrent_recheckconnection_speedcreate_subfolder_enabledcurrent_interface_addresscurrent_interface_namecurrent_network_interfacedelete_torrent_content_filesdhtdht_bootstrap_nodesdisk_cachedisk_cache_ttldisk_io_read_modedisk_io_typedisk_io_write_modedisk_queue_sizedl_limitdont_count_slow_torrentsdyndns_domaindyndns_enableddyndns_passworddyndns_servicedyndns_usernameembedded_tracker_portembedded_tracker_port_forwardingenable_coalesce_read_writeenable_embedded_trackerenable_multi_connections_from_same_ipenable_multi_connections_from_same_peer_idenable_os_cacheenable_piece_extent_affinityenable_upload_suggestionsencryptionexcluded_file_namesexcluded_file_names_enabledexport_direxport_dir_finfile_log_agefile_log_age_typefile_log_backup_enabledfile_log_delete_oldfile_log_enabledfile_log_max_sizefile_log_pathfile_pool_sizehashing_threadshostname_cache_ttli2p_addressi2p_enabledi2p_inbound_lengthi2p_inbound_length_variancei2p_inbound_quantityi2p_mixed_modei2p_outbound_lengthi2p_outbound_length_variancei2p_outbound_quantityi2p_pex_enabledi2p_portidn_support_enabledignore_ssl_errorsincomplete_files_extip_filter_enabledip_filter_pathip_filter_trackerslimit_lan_peerslimit_tcp_overheadlimit_utp_ratelisten_portlocalelsdmail_notification_auth_enabledmail_notification_emailmail_notification_enabledmail_notification_encryption_typemail_notification_passwordmail_notification_sendermail_notification_smtpmail_notification_ssl_enabledmail_notification_usernamemark_of_the_webmax_active_checking_torrentsmax_active_downloadsmax_active_torrentsmax_active_uploadsmax_concurrent_http_announcesmax_connecmax_connec_per_torrentmax_inactive_seeding_timemax_inactive_seeding_time_enabledmax_outstanding_block_requestsmax_ratiomax_ratio_actmax_ratio_enabledmax_seeding_timemax_seeding_time_enabledmax_uploadsmax_uploads_per_torrentmemory_working_set_limitmerge_trackersoutgoing_ports_maxoutgoing_ports_minpeer_tospeer_turnoverpeer_turnover_cutoffpeer_turnover_intervalperformance_warningpexpreallocate_allproxy_auth_enabledproxy_bittorrentproxy_hostname_lookupproxy_ipproxy_miscproxy_passwordproxy_peer_connectionsproxy_portproxy_rssproxy_torrents_onlyproxy_typeproxy_usernamepython_executable_pathqueueing_enabledrandom_portreannounce_when_address_changedrecheck_completed_torrentsrefresh_intervalremove_torrent_file_backuprequest_queue_sizeresolve_peer_countriesresolve_peer_host_namesresume_data_storage_typerss_auto_downloading_enabledrss_download_repack_proper_episodesrss_fetch_delayrss_max_articles_per_feedrss_processing_enabledrss_refresh_intervalrss_smart_episode_filterssave_pathsave_path_changed_tmm_enabledsave_resume_data_intervalsave_statistics_intervalscan_dirsschedule_from_hourschedule_from_minschedule_to_hourschedule_to_minscheduler_daysscheduler_enabledseeding_outgoing_connectionssend_buffer_low_watermarksend_buffer_watermarksend_buffer_watermark_factorshare_limits_modeshutdown_timeoutslow_torrent_dl_rate_thresholdslow_torrent_inactive_timerslow_torrent_ul_rate_thresholdsocket_backlog_sizesocket_receive_buffer_sizesocket_send_buffer_sizessl_certssl_enabledssl_keyssl_listen_portssrf_mitigationstart_pausedstart_paused_enabledstatus_bar_external_ipstop_tracker_timeoutstore_search_job_resultsstore_search_jobstemp_pathtemp_path_enabledtorrent_changed_tmm_enabledtorrent_content_layouttorrent_content_remove_optiontorrent_file_size_limittorrent_files_backup_dirtorrent_files_backup_enabledtorrent_files_finished_backup_dirtorrent_files_finished_backup_dir_enabledtorrent_stop_conditionup_limitupload_choking_algorithmupload_slots_behaviorupnpupnp_lease_durationuse_category_paths_in_manual_modeuse_httpsuse_subcategoriesuse_unwanted_folderutp_tcp_mixed_modevalidate_https_tracker_certificateweb_ui_addressweb_ui_api_keyweb_ui_ban_durationweb_ui_clickjacking_protection_enabledweb_ui_csrf_protection_enabledweb_ui_custom_http_headersweb_ui_domain_listweb_ui_host_header_validation_enabledweb_ui_https_cert_pathweb_ui_https_key_pathweb_ui_max_auth_fail_countweb_ui_passwordweb_ui_portweb_ui_reverse_proxies_listweb_ui_reverse_proxy_enabledweb_ui_secure_cookie_enabledweb_ui_session_timeoutweb_ui_sessions_count_limitweb_ui_upnpweb_ui_use_custom_http_headers_enabledweb_ui_usernamewebtorrent_stun_server