QBittorrentPrefs

@Serializable
class QBittorrentPrefs(val locale: String, val createSubfolderEnabled: Boolean? = null, val startPausedEnabled: Boolean? = null, val autoDeleteMode: Int, val preallocateAll: Boolean, val incompleteFilesExt: Boolean, val autoTmmEnabled: Boolean, val torrentChangedTmmEnabled: Boolean, val savePathChangedTmmEnabled: Boolean, val categoryChangedTmmEnabled: Boolean, val savePath: String, val tempPathEnabled: Boolean, val tempPath: String, val scanDirs: List<ScanDir>, val exportDir: String, val exportDirFinished: String, val mailNotificationEnabled: Boolean, val mailNotificationSender: String, val mailNotificationEmail: String, val mailNotificationSmtp: String, val mailNotificationSslEnabled: Boolean, val mailNotificationAuthEnabled: Boolean, val mailNotificationUsername: String, val mailNotificationPassword: String, val autorunEnabled: Boolean, val autorunProgram: String, val queueingEnabled: Boolean, val maxActiveDownloads: Int, val maxActiveTorrents: Int, val maxActiveUploads: Int, val dontCountSlowTorrents: Boolean, val slowTorrentDlRateThreshold: Int, val slowTorrentUlRateThreshold: Int, val slowTorrentInactiveTimer: Int, val maxRatioEnabled: Boolean, val maxRatio: Float, val maxRatioAction: MaxRatioAction, val listenPort: Int, val upnp: Boolean, val randomPort: Boolean, val dlLimit: Int, val upLimit: Int, val maxConnections: Int, val maxConnectionsPerTorrent: Int, val maxUploads: Int, val maxUploadsPerTorrent: Int, val stopTrackerTimeout: Int, val enablePieceExtentAffinity: Boolean, val bittorrentProtocol: BittorrentProtocol, val limitUtpRate: Boolean, val limitTcpOverhead: Boolean, val limitLanPeers: Boolean, val altDlLimit: Int, val altUpLimit: Int, val schedulerEnabled: Boolean, val scheduleFromHour: Int, val scheduleFromMin: Int, val scheduleToHour: Int, val scheduleToMin: Int, val schedulerDays: SchedulerDays, val dht: Boolean, val pex: Boolean, val lsd: Boolean, val encryption: TorrentEncryption, val anonymousMode: Boolean, val proxyType: ProxyType, val proxyIp: String, val proxyPort: Int, val proxyPeerConnections: Boolean, val proxyAuthEnabled: Boolean, val proxyUsername: String, val proxyPassword: String, val proxyTorrentsOnly: Boolean? = null, val ipFilterEnabled: Boolean, val ipFilterPath: String, val ipFilterTrackers: Boolean, val webUiDomainList: List<String>, val webUiAddress: String, val webUiPort: Int, val webUiUpnp: Boolean, val webUiUsername: String, val webUiPassword: String? = null, val webUiCsrfProtectionEnabled: Boolean, val webUiClickjackingProtectionEnabled: Boolean, val webUiSecureCookieEnabled: Boolean, val webUiMaxAuthFailCount: Int, val webUiBanDuration: Int, val webUiSessionTimeout: Int, val webUiHostHeaderValidationEnabled: Boolean, val bypassLocalAuth: Boolean, val bypassAuthSubnetWhitelistEnabled: Boolean, val bypassAuthSubnetWhitelist: List<String>, val alternativeWebUiEnabled: Boolean, val alternativeWebUiPath: String, val useHttps: Boolean, val webUiHttpsKeyPath: String, val webUiHttpsCertPath: String, val dyndnsEnabled: Boolean, val dyndnsService: DyndnsService, val dyndnsUsername: String, val dyndnsPassword: String, val dyndnsDomain: String, val rssRefreshInterval: Int, val rssMaxArticlesPerFeed: Int, val rssProcessingEnabled: Boolean, val rssAutoDownloadingEnabled: Boolean, val rssDownloadRepackProperEpisodes: Boolean, val rssSmartEpisodeFilters: String, val addTrackersEnabled: Boolean, val addTrackers: List<String>, val webUiUseCustomHttpHeadersEnabled: Boolean, val webUiCustomHttpHeaders: List<String>, val maxSeedingTimeEnabled: Boolean, val maxSeedingTime: Int, val announceIp: String, val announceToAllTiers: Boolean, val announceToAllTrackers: Boolean, val asyncIoThreads: Int, val bannedIps: List<String>, val checkingMemoryUse: Int, val currentInterfaceAddress: String, val currentNetworkInterface: String, val diskCache: Int, val diskCacheTtl: Int, val embeddedTrackerPort: Int, val enableCoalesceReadWrite: Boolean, val enableEmbeddedTracker: Boolean, val enableMultiConnectionsFromSameIp: Boolean, val enableOsCache: Boolean? = null, val enableUploadSuggestions: Boolean, val filePoolSize: Int, val outgoingPortsMax: Int, val outgoingPortsMin: Int, val recheckCompletedTorrents: Boolean, val resolvePeerCountries: Boolean, val saveResumeDataInterval: Int, val sendBufferLowWatermark: Int, val sendBufferWatermark: Int, val sendBufferWatermarkFactor: Int, val socketBacklogSize: Int, val uploadChokingAlgorithm: UploadChokingAlgorithm, val uploadSlotsBehavior: UploadSlotsBehavior, val upnpLeaseDuration: Int, val utpTcpMixedMode: UtpTcpMixedMode)

Constructors

Link copied to clipboard
constructor(locale: String, createSubfolderEnabled: Boolean? = null, startPausedEnabled: Boolean? = null, autoDeleteMode: Int, preallocateAll: Boolean, incompleteFilesExt: Boolean, autoTmmEnabled: Boolean, torrentChangedTmmEnabled: Boolean, savePathChangedTmmEnabled: Boolean, categoryChangedTmmEnabled: Boolean, savePath: String, tempPathEnabled: Boolean, tempPath: String, scanDirs: List<ScanDir>, exportDir: String, exportDirFinished: String, mailNotificationEnabled: Boolean, mailNotificationSender: String, mailNotificationEmail: String, mailNotificationSmtp: String, mailNotificationSslEnabled: Boolean, mailNotificationAuthEnabled: Boolean, mailNotificationUsername: String, mailNotificationPassword: String, autorunEnabled: Boolean, autorunProgram: String, queueingEnabled: Boolean, maxActiveDownloads: Int, maxActiveTorrents: Int, maxActiveUploads: Int, dontCountSlowTorrents: Boolean, slowTorrentDlRateThreshold: Int, slowTorrentUlRateThreshold: Int, slowTorrentInactiveTimer: Int, maxRatioEnabled: Boolean, maxRatio: Float, maxRatioAction: MaxRatioAction, listenPort: Int, upnp: Boolean, randomPort: Boolean, dlLimit: Int, upLimit: Int, maxConnections: Int, maxConnectionsPerTorrent: Int, maxUploads: Int, maxUploadsPerTorrent: Int, stopTrackerTimeout: Int, enablePieceExtentAffinity: Boolean, bittorrentProtocol: BittorrentProtocol, limitUtpRate: Boolean, limitTcpOverhead: Boolean, limitLanPeers: Boolean, altDlLimit: Int, altUpLimit: Int, schedulerEnabled: Boolean, scheduleFromHour: Int, scheduleFromMin: Int, scheduleToHour: Int, scheduleToMin: Int, schedulerDays: SchedulerDays, dht: Boolean, pex: Boolean, lsd: Boolean, encryption: TorrentEncryption, anonymousMode: Boolean, proxyType: ProxyType, proxyIp: String, proxyPort: Int, proxyPeerConnections: Boolean, proxyAuthEnabled: Boolean, proxyUsername: String, proxyPassword: String, proxyTorrentsOnly: Boolean? = null, ipFilterEnabled: Boolean, ipFilterPath: String, ipFilterTrackers: Boolean, webUiDomainList: List<String>, webUiAddress: String, webUiPort: Int, webUiUpnp: Boolean, webUiUsername: String, webUiPassword: String? = null, webUiCsrfProtectionEnabled: Boolean, webUiClickjackingProtectionEnabled: Boolean, webUiSecureCookieEnabled: Boolean, webUiMaxAuthFailCount: Int, webUiBanDuration: Int, webUiSessionTimeout: Int, webUiHostHeaderValidationEnabled: Boolean, bypassLocalAuth: Boolean, bypassAuthSubnetWhitelistEnabled: Boolean, bypassAuthSubnetWhitelist: List<String>, alternativeWebUiEnabled: Boolean, alternativeWebUiPath: String, useHttps: Boolean, webUiHttpsKeyPath: String, webUiHttpsCertPath: String, dyndnsEnabled: Boolean, dyndnsService: DyndnsService, dyndnsUsername: String, dyndnsPassword: String, dyndnsDomain: String, rssRefreshInterval: Int, rssMaxArticlesPerFeed: Int, rssProcessingEnabled: Boolean, rssAutoDownloadingEnabled: Boolean, rssDownloadRepackProperEpisodes: Boolean, rssSmartEpisodeFilters: String, addTrackersEnabled: Boolean, addTrackers: List<String>, webUiUseCustomHttpHeadersEnabled: Boolean, webUiCustomHttpHeaders: List<String>, maxSeedingTimeEnabled: Boolean, maxSeedingTime: Int, announceIp: String, announceToAllTiers: Boolean, announceToAllTrackers: Boolean, asyncIoThreads: Int, bannedIps: List<String>, checkingMemoryUse: Int, currentInterfaceAddress: String, currentNetworkInterface: String, diskCache: Int, diskCacheTtl: Int, embeddedTrackerPort: Int, enableCoalesceReadWrite: Boolean, enableEmbeddedTracker: Boolean, enableMultiConnectionsFromSameIp: Boolean, enableOsCache: Boolean? = null, enableUploadSuggestions: Boolean, filePoolSize: Int, outgoingPortsMax: Int, outgoingPortsMin: Int, recheckCompletedTorrents: Boolean, resolvePeerCountries: Boolean, saveResumeDataInterval: Int, sendBufferLowWatermark: Int, sendBufferWatermark: Int, sendBufferWatermarkFactor: Int, socketBacklogSize: Int, uploadChokingAlgorithm: UploadChokingAlgorithm, uploadSlotsBehavior: UploadSlotsBehavior, upnpLeaseDuration: Int, utpTcpMixedMode: UtpTcpMixedMode)

Properties

Link copied to clipboard
@Serializable(with = NewLineListSerializer::class)
@SerialName(value = "add_trackers")
val addTrackers: List<String>

List of trackers to add to new torrent

Link copied to clipboard
@SerialName(value = "add_trackers_enabled")
val addTrackersEnabled: Boolean

Enable automatic adding of trackers to new torrents

Link copied to clipboard
@SerialName(value = "alt_dl_limit")
val altDlLimit: Int

Alternative global download speed limit in KiB/s

Link copied to clipboard
@SerialName(value = "alternative_webui_enabled")
val alternativeWebUiEnabled: Boolean

True if an alternative WebUI should be used

Link copied to clipboard
@SerialName(value = "alternative_webui_path")
val alternativeWebUiPath: String

File path to the alternative WebUI

Link copied to clipboard
@SerialName(value = "alt_up_limit")
val altUpLimit: Int

Alternative global upload speed limit in KiB/s

Link copied to clipboard
@SerialName(value = "announce_ip")
val announceIp: String
Link copied to clipboard
@SerialName(value = "announce_to_all_tiers")
val announceToAllTiers: Boolean

True always announce to all tiers

Link copied to clipboard
@SerialName(value = "announce_to_all_trackers")
val announceToAllTrackers: Boolean

True always announce to all trackers in a tier

Link copied to clipboard
@SerialName(value = "anonymous_mode")
val anonymousMode: Boolean

If true anonymous mode will be enabled

Link copied to clipboard
@SerialName(value = "async_io_threads")
val asyncIoThreads: Int

Number of asynchronous I/O threads

Link copied to clipboard
@SerialName(value = "auto_delete_mode")
val autoDeleteMode: Int
Link copied to clipboard
@SerialName(value = "autorun_enabled")
val autorunEnabled: Boolean

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

Link copied to clipboard
@SerialName(value = "autorun_program")
val autorunProgram: 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

Link copied to clipboard
@SerialName(value = "auto_tmm_enabled")
val autoTmmEnabled: Boolean

True if Automatic Torrent Management is enabled by default

Link copied to clipboard
@Serializable(with = NewLineListSerializer::class)
@SerialName(value = "banned_IPs")
val bannedIps: List<String>

List of banned IPs

Link copied to clipboard
@SerialName(value = "bittorrent_protocol")
val bittorrentProtocol: BittorrentProtocol

Bittorrent Protocol to use (see list of possible values below)

Link copied to clipboard
@Serializable(with = NewLineListSerializer::class)
@SerialName(value = "bypass_auth_subnet_whitelist")
val bypassAuthSubnetWhitelist: List<String>

(White)list of ipv4/ipv6 subnets for which webui authentication should be bypassed

Link copied to clipboard
@SerialName(value = "bypass_auth_subnet_whitelist_enabled")
val bypassAuthSubnetWhitelistEnabled: Boolean

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

Link copied to clipboard
@SerialName(value = "bypass_local_auth")
val bypassLocalAuth: Boolean

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

Link copied to clipboard
@SerialName(value = "category_changed_tmm_enabled")
val categoryChangedTmmEnabled: Boolean

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

Link copied to clipboard
@SerialName(value = "checking_memory_use")
val checkingMemoryUse: Int

Outstanding memory when checking torrents in MiB

Link copied to clipboard
@SerialName(value = "create_subfolder_enabled")
val createSubfolderEnabled: Boolean? = null

True if a subfolder should be created when adding a torrent

Link copied to clipboard
@SerialName(value = "current_interface_address")
val currentInterfaceAddress: String

IP Address to bind to. Empty String means All addresses

Link copied to clipboard
@SerialName(value = "current_network_interface")
val currentNetworkInterface: String

Network Interface used

Link copied to clipboard

True if DHT is enabled

Link copied to clipboard
@SerialName(value = "disk_cache")
val diskCache: Int

Disk cache used in MiB

Link copied to clipboard
@SerialName(value = "disk_cache_ttl")
val diskCacheTtl: Int

Disk cache expiry interval in seconds

Link copied to clipboard
@SerialName(value = "dl_limit")
val dlLimit: Int

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

Link copied to clipboard
@SerialName(value = "dont_count_slow_torrents")
val dontCountSlowTorrents: Boolean

If true torrents w/o any activity (stalled ones) will not be counted towards max_active_* limits

Link copied to clipboard
@SerialName(value = "dyndns_domain")
val dyndnsDomain: String

Your DDNS domain name

Link copied to clipboard
@SerialName(value = "dyndns_enabled")
val dyndnsEnabled: Boolean

True if server DNS should be updated dynamically

Link copied to clipboard
@SerialName(value = "dyndns_password")
val dyndnsPassword: String

Password for DDNS service

Link copied to clipboard
@Serializable(with = DyndnsServiceSerializer::class)
@SerialName(value = "dyndns_service")
val dyndnsService: DyndnsService
Link copied to clipboard
@SerialName(value = "dyndns_username")
val dyndnsUsername: String

Username for DDNS service

Link copied to clipboard
@SerialName(value = "embedded_tracker_port")
val embeddedTrackerPort: Int

Port used for embedded tracker

Link copied to clipboard
@SerialName(value = "enable_coalesce_read_write")
val enableCoalesceReadWrite: Boolean

True enables coalesce reads & writes

Link copied to clipboard
@SerialName(value = "enable_embedded_tracker")
val enableEmbeddedTracker: Boolean

True enables embedded tracker

Link copied to clipboard
@SerialName(value = "enable_multi_connections_from_same_ip")
val enableMultiConnectionsFromSameIp: Boolean

True allows multiple connections from the same IP address

Link copied to clipboard
@SerialName(value = "enable_os_cache")
val enableOsCache: Boolean? = null

True enables os cache

Link copied to clipboard
@SerialName(value = "enable_piece_extent_affinity")
val enablePieceExtentAffinity: Boolean

True if the advanced libtorrent option piece_extent_affinity is enabled

Link copied to clipboard
@SerialName(value = "enable_upload_suggestions")
val enableUploadSuggestions: Boolean

True enables sending of upload piece suggestions

Link copied to clipboard
Link copied to clipboard
@SerialName(value = "export_dir")
val exportDir: String

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

Link copied to clipboard
@SerialName(value = "export_dir_fin")
val exportDirFinished: String

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

Link copied to clipboard
@SerialName(value = "file_pool_size")
val filePoolSize: Int

File pool size

Link copied to clipboard
@SerialName(value = "incomplete_files_ext")
val incompleteFilesExt: Boolean

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

Link copied to clipboard
@SerialName(value = "ip_filter_enabled")
val ipFilterEnabled: Boolean

True if external IP filter should be enabled

Link copied to clipboard
@SerialName(value = "ip_filter_path")
val ipFilterPath: String

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

Link copied to clipboard
@SerialName(value = "ip_filter_trackers")
val ipFilterTrackers: Boolean

True if IP filters are applied to trackers

Link copied to clipboard
@SerialName(value = "limit_lan_peers")
val limitLanPeers: Boolean

True if dul_limit should be applied to peers on the LAN

Link copied to clipboard
@SerialName(value = "limit_tcp_overhead")
val limitTcpOverhead: Boolean

True if dul_limit should be applied to estimated TCP overhead (service data: e.g. packet headers)

Link copied to clipboard
@SerialName(value = "limit_utp_rate")
val limitUtpRate: Boolean

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

Link copied to clipboard
@SerialName(value = "listen_port")
val listenPort: Int

Port for incoming connections

Link copied to clipboard

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

Link copied to clipboard

True if LSD is enabled

Link copied to clipboard
@SerialName(value = "mail_notification_auth_enabled")
val mailNotificationAuthEnabled: Boolean

True if smtp server requires authentication

Link copied to clipboard
@SerialName(value = "mail_notification_email")
val mailNotificationEmail: String

e-mail to send notifications to

Link copied to clipboard
@SerialName(value = "mail_notification_enabled")
val mailNotificationEnabled: Boolean

True if e-mail notification should be enabled

Link copied to clipboard
@SerialName(value = "mail_notification_password")
val mailNotificationPassword: String

Password for smtp authentication

Link copied to clipboard
@SerialName(value = "mail_notification_sender")
val mailNotificationSender: String

e-mail where notifications should originate from

Link copied to clipboard
@SerialName(value = "mail_notification_smtp")
val mailNotificationSmtp: String

smtp server for e-mail notifications

Link copied to clipboard
@SerialName(value = "mail_notification_ssl_enabled")
val mailNotificationSslEnabled: Boolean

True if smtp server requires SSL connection

Link copied to clipboard
@SerialName(value = "mail_notification_username")
val mailNotificationUsername: String

Username for smtp authentication

Link copied to clipboard
@SerialName(value = "max_active_downloads")
val maxActiveDownloads: Int

Maximum number of active simultaneous downloads

Link copied to clipboard
@SerialName(value = "max_active_torrents")
val maxActiveTorrents: Int

Maximum number of active simultaneous downloads and uploads

Link copied to clipboard
@SerialName(value = "max_active_uploads")
val maxActiveUploads: Int

Maximum number of active simultaneous uploads

Link copied to clipboard
@SerialName(value = "max_connec")
val maxConnections: Int

Maximum global number of simultaneous connections

Link copied to clipboard
@SerialName(value = "max_connec_per_torrent")
val maxConnectionsPerTorrent: Int

Maximum number of simultaneous connections per torrent

Link copied to clipboard
@SerialName(value = "max_ratio")
val maxRatio: Float

Get the global share ratio limit

Link copied to clipboard
@Serializable(with = MaxRatioActionSerializer::class)
@SerialName(value = "max_ratio_act")
val maxRatioAction: MaxRatioAction

Action performed when a torrent reaches the maximum share ratio.

Link copied to clipboard
@SerialName(value = "max_ratio_enabled")
val maxRatioEnabled: Boolean

True if share ratio limit is enabled

Link copied to clipboard
@SerialName(value = "max_seeding_time")
val maxSeedingTime: Int

Number of minutes to seed a torrent

Link copied to clipboard
@SerialName(value = "max_seeding_time_enabled")
val maxSeedingTimeEnabled: Boolean

True enables max seeding time

Link copied to clipboard
@SerialName(value = "max_uploads")
val maxUploads: Int

Maximum number of upload slots

Link copied to clipboard
@SerialName(value = "max_uploads_per_torrent")
val maxUploadsPerTorrent: Int

Maximum number of upload slots per torrent

Link copied to clipboard
@SerialName(value = "outgoing_ports_max")
val outgoingPortsMax: Int

Maximal outgoing port (0: Disabled)

Link copied to clipboard
@SerialName(value = "outgoing_ports_min")
val outgoingPortsMin: Int

Minimal outgoing port (0: Disabled)

Link copied to clipboard

True if PeX is enabled

Link copied to clipboard
@SerialName(value = "preallocate_all")
val preallocateAll: Boolean

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

Link copied to clipboard
@SerialName(value = "proxy_auth_enabled")
val proxyAuthEnabled: Boolean

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

Link copied to clipboard
@SerialName(value = "proxy_ip")
val proxyIp: String

Proxy IP address or domain name

Link copied to clipboard
@SerialName(value = "proxy_password")
val proxyPassword: String

Password for proxy authentication

Link copied to clipboard
@SerialName(value = "proxy_peer_connections")
val proxyPeerConnections: Boolean

True if peer and web seed connections should be proxified

Link copied to clipboard
@SerialName(value = "proxy_port")
val proxyPort: Int

Proxy port

Link copied to clipboard
@SerialName(value = "proxy_torrents_only")
val proxyTorrentsOnly: Boolean? = null

True if proxy is only used for torrents

Link copied to clipboard
@SerialName(value = "proxy_type")
val proxyType: ProxyType
Link copied to clipboard
@SerialName(value = "proxy_username")
val proxyUsername: String

Username for proxy authentication

Link copied to clipboard
@SerialName(value = "queueing_enabled")
val queueingEnabled: Boolean

True if torrent queuing is enabled

Link copied to clipboard
@SerialName(value = "random_port")
val randomPort: Boolean

True if the port is randomly selected

Link copied to clipboard
@SerialName(value = "recheck_completed_torrents")
val recheckCompletedTorrents: Boolean

True rechecks torrents on completion

Link copied to clipboard
@SerialName(value = "resolve_peer_countries")
val resolvePeerCountries: Boolean

True resolves peer countries

Link copied to clipboard
@SerialName(value = "rss_auto_downloading_enabled")
val rssAutoDownloadingEnabled: Boolean

Enable auto-downloading of torrents from the RSS feeds

Link copied to clipboard
@SerialName(value = "rss_download_repack_proper_episodes")
val rssDownloadRepackProperEpisodes: Boolean

Enable downloading of repack/proper Episodes

Link copied to clipboard
@SerialName(value = "rss_max_articles_per_feed")
val rssMaxArticlesPerFeed: Int

Max stored articles per RSS feed

Link copied to clipboard
@SerialName(value = "rss_processing_enabled")
val rssProcessingEnabled: Boolean

Enable processing of RSS feeds

Link copied to clipboard
@SerialName(value = "rss_refresh_interval")
val rssRefreshInterval: Int

RSS refresh interval

Link copied to clipboard
@SerialName(value = "rss_smart_episode_filters")
val rssSmartEpisodeFilters: String

List of RSS Smart Episode Filters

Link copied to clipboard
@SerialName(value = "save_path")
val savePath: String

Default save path for torrents, separated by slashes

Link copied to clipboard
@SerialName(value = "save_path_changed_tmm_enabled")
val savePathChangedTmmEnabled: Boolean

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

Link copied to clipboard
@SerialName(value = "save_resume_data_interval")
val saveResumeDataInterval: Int

Save resume data interval in min

Link copied to clipboard
@Serializable(with = ScanDirSerializer::class)
@SerialName(value = "scan_dirs")
val scanDirs: List<ScanDir>
Link copied to clipboard
@SerialName(value = "schedule_from_hour")
val scheduleFromHour: Int

Scheduler starting hour

Link copied to clipboard
@SerialName(value = "schedule_from_min")
val scheduleFromMin: Int

Scheduler starting minute

Link copied to clipboard
@Serializable(with = SchedulerDaysSerializer::class)
@SerialName(value = "scheduler_days")
val schedulerDays: SchedulerDays

Scheduler days

Link copied to clipboard
@SerialName(value = "scheduler_enabled")
val schedulerEnabled: Boolean

True if alternative limits should be applied according to schedule

Link copied to clipboard
@SerialName(value = "schedule_to_hour")
val scheduleToHour: Int

Scheduler ending hour

Link copied to clipboard
@SerialName(value = "schedule_to_min")
val scheduleToMin: Int

Scheduler ending minute

Link copied to clipboard
@SerialName(value = "send_buffer_low_watermark")
val sendBufferLowWatermark: Int

Send buffer low watermark in KiB

Link copied to clipboard
@SerialName(value = "send_buffer_watermark")
val sendBufferWatermark: Int

Send buffer watermark in KiB

Link copied to clipboard
@SerialName(value = "send_buffer_watermark_factor")
val sendBufferWatermarkFactor: Int

Send buffer watermark factor in percent

Link copied to clipboard
@SerialName(value = "slow_torrent_dl_rate_threshold")
val slowTorrentDlRateThreshold: Int

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

Link copied to clipboard
@SerialName(value = "slow_torrent_inactive_timer")
val slowTorrentInactiveTimer: Int

Seconds a torrent should be inactive before considered "slow"

Link copied to clipboard
@SerialName(value = "slow_torrent_ul_rate_threshold")
val slowTorrentUlRateThreshold: Int

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

Link copied to clipboard
@SerialName(value = "socket_backlog_size")
val socketBacklogSize: Int

Socket backlog size

Link copied to clipboard
@SerialName(value = "start_paused_enabled")
val startPausedEnabled: Boolean? = null

True if torrents should be added in a Paused state

Link copied to clipboard
@SerialName(value = "stop_tracker_timeout")
val stopTrackerTimeout: Int

Timeout in seconds for a stopped announce request to trackers

Link copied to clipboard
@SerialName(value = "temp_path")
val tempPath: String

Path for incomplete torrents, separated by slashes

Link copied to clipboard
@SerialName(value = "temp_path_enabled")
val tempPathEnabled: Boolean

True if folder for incomplete torrents is enabled

Link copied to clipboard
@SerialName(value = "torrent_changed_tmm_enabled")
val torrentChangedTmmEnabled: Boolean

True if torrent should be relocated when its Category changes

Link copied to clipboard
@SerialName(value = "up_limit")
val upLimit: Int

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

Link copied to clipboard
@SerialName(value = "upload_choking_algorithm")
val uploadChokingAlgorithm: UploadChokingAlgorithm

Upload choking algorithm used

Link copied to clipboard
@SerialName(value = "upload_slots_behavior")
val uploadSlotsBehavior: UploadSlotsBehavior

Upload slots behavior used

Link copied to clipboard

True if UPnP/NAT-PMP is enabled

Link copied to clipboard
@SerialName(value = "upnp_lease_duration")
val upnpLeaseDuration: Int

UPnP lease duration (0: Permanent lease)

Link copied to clipboard
@SerialName(value = "use_https")
val useHttps: Boolean

True if WebUI HTTPS access is enabled

Link copied to clipboard
@Serializable(with = UtpTcpMixedModeSerializer::class)
@SerialName(value = "utp_tcp_mixed_mode")
val utpTcpMixedMode: UtpTcpMixedMode

μTP-TCP mixed mode algorithm

Link copied to clipboard
@SerialName(value = "web_ui_address")
val webUiAddress: String

IP address to use for the WebUI

Link copied to clipboard
@SerialName(value = "web_ui_ban_duration")
val webUiBanDuration: Int

WebUI access ban duration in seconds

Link copied to clipboard
@SerialName(value = "web_ui_clickjacking_protection_enabled")
val webUiClickjackingProtectionEnabled: Boolean

True if WebUI clickjacking protection is enabled

Link copied to clipboard
@SerialName(value = "web_ui_csrf_protection_enabled")
val webUiCsrfProtectionEnabled: Boolean

True if WebUI CSRF protection is enabled

Link copied to clipboard
@Serializable(with = NewLineListSerializer::class)
@SerialName(value = "web_ui_custom_http_headers")
val webUiCustomHttpHeaders: List<String>

List of custom http headers

Link copied to clipboard
@Serializable(with = SemiColonListSerializer::class)
@SerialName(value = "web_ui_domain_list")
val webUiDomainList: List<String>

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

Link copied to clipboard
@SerialName(value = "web_ui_host_header_validation_enabled")
val webUiHostHeaderValidationEnabled: Boolean

True if WebUI host header validation is enabled

Link copied to clipboard
@SerialName(value = "web_ui_https_cert_path")
val webUiHttpsCertPath: String

Path to SSL certificate

Link copied to clipboard
@SerialName(value = "web_ui_https_key_path")
val webUiHttpsKeyPath: String

Path to SSL keyfile

Link copied to clipboard
@SerialName(value = "web_ui_max_auth_fail_count")
val webUiMaxAuthFailCount: Int

Maximum number of authentication failures before WebUI access ban

Link copied to clipboard
@SerialName(value = "web_ui_password")
val webUiPassword: String? = null

Plaintext WebUI password, not readable, write-only

Link copied to clipboard
@SerialName(value = "web_ui_port")
val webUiPort: Int

WebUI port

Link copied to clipboard
@SerialName(value = "web_ui_secure_cookie_enabled")
val webUiSecureCookieEnabled: Boolean

True if WebUI cookie Secure flag is enabled

Link copied to clipboard
@SerialName(value = "web_ui_session_timeout")
val webUiSessionTimeout: Int

Seconds until WebUI is automatically signed off

Link copied to clipboard
@SerialName(value = "web_ui_upnp")
val webUiUpnp: Boolean

True if UPnP is used for the WebUI port

Link copied to clipboard
@SerialName(value = "web_ui_use_custom_http_headers_enabled")
val webUiUseCustomHttpHeadersEnabled: Boolean

Enable custom http headers

Link copied to clipboard
@SerialName(value = "web_ui_username")
val webUiUsername: String

WebUI username