Interface Preferences

interface Preferences {
    add_trackers: string;
    add_trackers_enabled: boolean;
    alt_dl_limit: number;
    alt_up_limit: number;
    alternative_webui_enabled: boolean;
    alternative_webui_path: string;
    announce_ip: string;
    announce_to_all_tiers: boolean;
    announce_to_all_trackers: boolean;
    anonymous_mode: boolean;
    async_io_threads: number;
    auto_delete_mode: number;
    auto_tmm_enabled: boolean;
    autorun_enabled: boolean;
    autorun_program: string;
    banned_IPs: string;
    bittorrent_protocol: 0 | 1 | 2;
    bypass_auth_subnet_whitelist: string;
    bypass_auth_subnet_whitelist_enabled: boolean;
    bypass_local_auth: boolean;
    category_changed_tmm_enabled: boolean;
    checking_memory_use: number;
    create_subfolder_enabled: boolean;
    current_interface_address: string;
    current_network_interface: string;
    dht: boolean;
    disk_cache: number;
    disk_cache_ttl: 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;
    enable_coalesce_read_write: boolean;
    enable_embedded_tracker: boolean;
    enable_multi_connections_from_same_ip: boolean;
    enable_os_cache: boolean;
    enable_piece_extent_affinity: boolean;
    enable_upload_suggestions: boolean;
    encryption: 0 | 1 | 2;
    export_dir: string;
    export_dir_fin: string;
    file_pool_size: number;
    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_password: string;
    mail_notification_sender: string;
    mail_notification_smtp: string;
    mail_notification_ssl_enabled: boolean;
    mail_notification_username: string;
    max_active_downloads: number;
    max_active_torrents: number;
    max_active_uploads: number;
    max_connec: number;
    max_connec_per_torrent: 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;
    outgoing_ports_max: number;
    outgoing_ports_min: number;
    pex: boolean;
    preallocate_all: boolean;
    proxy_auth_enabled: boolean;
    proxy_ip: string;
    proxy_password: string;
    proxy_peer_connections: boolean;
    proxy_port: number;
    proxy_torrents_only: boolean;
    proxy_type: number;
    proxy_username: string;
    queueing_enabled: boolean;
    random_port: boolean;
    recheck_completed_torrents: boolean;
    resolve_peer_countries: boolean;
    rss_auto_downloading_enabled: boolean;
    rss_download_repack_proper_episodes: boolean;
    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;
    scan_dirs: Record<string, string | 0 | 1>;
    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;
    send_buffer_low_watermark: number;
    send_buffer_watermark: number;
    send_buffer_watermark_factor: number;
    slow_torrent_dl_rate_threshold: number;
    slow_torrent_inactive_timer: number;
    slow_torrent_ul_rate_threshold: number;
    socket_backlog_size: number;
    ssl_cert: string;
    ssl_key: string;
    start_paused_enabled: boolean;
    stop_tracker_timeout: number;
    temp_path: string;
    temp_path_enabled: boolean;
    torrent_changed_tmm_enabled: boolean;
    up_limit: number;
    upload_choking_algorithm: number;
    upload_slots_behavior: number;
    upnp: boolean;
    upnp_lease_duration: number;
    use_https: boolean;
    utp_tcp_mixed_mode: number;
    web_ui_address: 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_secure_cookie_enabled: boolean;
    web_ui_session_timeout: number;
    web_ui_upnp: boolean;
    web_ui_use_custom_http_headers_enabled: boolean;
    web_ui_username: string;
}

Properties

add_trackers add_trackers_enabled alt_dl_limit alt_up_limit alternative_webui_enabled alternative_webui_path announce_ip announce_to_all_tiers announce_to_all_trackers anonymous_mode async_io_threads auto_delete_mode auto_tmm_enabled autorun_enabled autorun_program banned_IPs bittorrent_protocol bypass_auth_subnet_whitelist bypass_auth_subnet_whitelist_enabled bypass_local_auth category_changed_tmm_enabled checking_memory_use create_subfolder_enabled current_interface_address current_network_interface dht disk_cache disk_cache_ttl dl_limit dont_count_slow_torrents dyndns_domain dyndns_enabled dyndns_password dyndns_service dyndns_username embedded_tracker_port enable_coalesce_read_write enable_embedded_tracker enable_multi_connections_from_same_ip enable_os_cache enable_piece_extent_affinity enable_upload_suggestions encryption export_dir export_dir_fin file_pool_size 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_password mail_notification_sender mail_notification_smtp mail_notification_ssl_enabled mail_notification_username max_active_downloads max_active_torrents max_active_uploads max_connec max_connec_per_torrent max_ratio max_ratio_act max_ratio_enabled max_seeding_time max_seeding_time_enabled max_uploads max_uploads_per_torrent outgoing_ports_max outgoing_ports_min pex preallocate_all proxy_auth_enabled proxy_ip proxy_password proxy_peer_connections proxy_port proxy_torrents_only proxy_type proxy_username queueing_enabled random_port recheck_completed_torrents resolve_peer_countries rss_auto_downloading_enabled rss_download_repack_proper_episodes 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 scan_dirs schedule_from_hour schedule_from_min schedule_to_hour schedule_to_min scheduler_days scheduler_enabled send_buffer_low_watermark send_buffer_watermark send_buffer_watermark_factor slow_torrent_dl_rate_threshold slow_torrent_inactive_timer slow_torrent_ul_rate_threshold socket_backlog_size ssl_cert ssl_key start_paused_enabled stop_tracker_timeout temp_path temp_path_enabled torrent_changed_tmm_enabled up_limit upload_choking_algorithm upload_slots_behavior upnp upnp_lease_duration use_https utp_tcp_mixed_mode web_ui_address 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_secure_cookie_enabled web_ui_session_timeout web_ui_upnp web_ui_use_custom_http_headers_enabled web_ui_username

Properties

add_trackers: string

List of trackers to add to new torrent

add_trackers_enabled: boolean

Enable automatic adding of trackers to new torrents

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_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

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_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

bittorrent_protocol: 0 | 1 | 2

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

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

create_subfolder_enabled: boolean

True if a subfolder should be created when adding a torrent

current_interface_address: string

IP Address to bind to. Empty String means All addresses

current_network_interface: string

Network Interface used

dht: boolean

True if DHT is enabled

disk_cache: number

Disk cache used in MiB

disk_cache_ttl: number

Disk cache expiry interval in seconds

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

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_os_cache: boolean

True enables os cache

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

export_dir: string

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

export_dir_fin: string

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

file_pool_size: number

File pool size

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_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

mail_notification_username: string

Username for smtp authentication

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_connec: number

Maximum global number of simultaneous connections

max_connec_per_torrent: number

Maximum number of simultaneous connections per torrent

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

outgoing_ports_max: number

Maximal outgoing port (0: Disabled)

outgoing_ports_min: number

Minimal outgoing port (0: Disabled)

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_ip: string

Proxy IP address or domain name

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_torrents_only: boolean

True if proxy is only used for torrents

proxy_type: number

See list of possible values here below

proxy_username: string

Username for proxy authentication

queueing_enabled: boolean

True if torrent queuing is enabled

random_port: boolean

True if the port is randomly selected

recheck_completed_torrents: boolean

True rechecks torrents on completion

resolve_peer_countries: boolean

True resolves peer countries

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_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

scan_dirs: Record<string, string | 0 | 1>

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

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

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

ssl_cert: string

SSL certificate contents (this is a not a path)

ssl_key: string

SSL keyfile contents (this is a not a path)

start_paused_enabled: boolean

True if torrents should be added in a Paused state

stop_tracker_timeout: number

Timeout in seconds for a stopped announce request to trackers

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

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_https: boolean

True if WebUI HTTPS access is enabled

utp_tcp_mixed_mode: number

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

web_ui_address: string

IP address to use for the WebUI

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

web_ui_port: number

WebUI port

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_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