Class Preferences

qBittorrent application preferences.

Inheritance

System.Object

Preferences

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: QBittorrent.Client

Assembly: QBittorrent.Client.dll

Syntax

[JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)]
public class Preferences

Properties

AdditinalTrackers

The list of addional trackers.

Declaration

[JsonProperty("add_trackers")]
[JsonConverter(typeof(SeparatedStringToListConverter), new object[]{"\n"})]
public IList<string> AdditinalTrackers { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

AdditionalData

Additional properties not handled by this library.

Declaration

[JsonExtensionData]
public IDictionary<string, JToken> AdditionalData { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, Newtonsoft.Json.Linq.JToken>

AdditionalTrackersEnabled

True if additional trackers are enabled.

Declaration

[JsonProperty("add_trackers_enabled")]
public bool? AdditionalTrackersEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AddTorrentPaused

True if torrents should be added in a Paused state

Declaration

[JsonProperty("start_paused_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public bool? AddTorrentPaused { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AlternativeDownloadLimit

Alternative global download speed limit in KiB/s

Declaration

[JsonProperty("alt_dl_limit")]
public int? AlternativeDownloadLimit { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

AlternativeUploadLimit

Alternative global upload speed limit in KiB/s

Declaration

[JsonProperty("alt_up_limit")]
public int? AlternativeUploadLimit { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

AlternativeWebUIEnabled

True if an alternative WebUI should be used

Declaration

[JsonProperty("alternative_webui_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public bool? AlternativeWebUIEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AlternativeWebUIPath

File path to the alternative WebUI

Declaration

[JsonProperty("alternative_webui_path")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public string AlternativeWebUIPath { get; set; }

Property Value

Type	Description
System.String

AnonymousMode

If true anonymous mode will be enabled.

Declaration

[JsonProperty("anonymous_mode")]
public bool? AnonymousMode { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AppendExtensionToIncompleteFiles

If true .!qB extension will be appended to incomplete files.

Declaration

[JsonProperty("incomplete_files_ext")]
public bool? AppendExtensionToIncompleteFiles { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AutorunEnabled

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

Declaration

[JsonProperty("autorun_enabled")]
public bool? AutorunEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AutorunProgram

Program path/name/arguments to run if AutorunEnabled is true.

Declaration

[JsonProperty("autorun_program")]
public string AutorunProgram { get; set; }

Property Value

Type	Description
System.String

AutoTMMEnabledByDefault

True if Automatic Torrent Management is enabled by default

Declaration

[JsonProperty("auto_tmm_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public bool? AutoTMMEnabledByDefault { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AutoTMMRetainedWhenCategoryChanges

True if torrent should be relocated when its category changes

Declaration

[JsonProperty("torrent_changed_tmm_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public bool? AutoTMMRetainedWhenCategoryChanges { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AutoTMMRetainedWhenCategorySavePathChanges

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

Declaration

[JsonProperty("category_changed_tmm_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public bool? AutoTMMRetainedWhenCategorySavePathChanges { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AutoTMMRetainedWhenDefaultSavePathChanges

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

Declaration

[JsonProperty("save_path_changed_tmm_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public bool? AutoTMMRetainedWhenDefaultSavePathChanges { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

BannedIpAddresses

The list of banned IP addresses.

Declaration

[JsonProperty("banned_IPs")]
[JsonConverter(typeof(SeparatedStringToListConverter), new object[]{"\n"})]
public IList<string> BannedIpAddresses { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

BittorrentProtocol

Bittorrent protocol.

Declaration

[JsonProperty("bittorrent_protocol")]
public BittorrentProtocol? BittorrentProtocol { get; set; }

Property Value

Type	Description
System.Nullable<BittorrentProtocol>

BypassAuthenticationSubnetWhitelist

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

Declaration

[JsonProperty("bypass_auth_subnet_whitelist")]
[JsonConverter(typeof(SeparatedStringToListConverter), new object[]{",", "\n"})]
public IList<string> BypassAuthenticationSubnetWhitelist { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

See Also

BypassAuthenticationSubnetWhitelistEnabled

BypassLocalAuthentication

BypassAuthenticationSubnetWhitelistEnabled

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

Declaration

[JsonProperty("bypass_auth_subnet_whitelist_enabled")]
public bool? BypassAuthenticationSubnetWhitelistEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

See Also

BypassAuthenticationSubnetWhitelist

BypassLocalAuthentication

BypassLocalAuthentication

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

Declaration

[JsonProperty("bypass_local_auth")]
public bool? BypassLocalAuthentication { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

CreateTorrentSubfolder

True if a subfolder should be created when adding a torrent

Declaration

[JsonProperty("create_subfolder_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
[Deprecated("2.7.0")]
public bool? CreateTorrentSubfolder { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

CurrentInterfaceAddress

Current network interface address

Declaration

[JsonProperty("current_interface_address")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public string CurrentInterfaceAddress { get; set; }

Property Value

Type	Description
System.String

CurrentNetworkInterface

Specifies which network interfaces qBittorrent listens on. On multi-nic systems (e.g. device has an ethernet port and wifi) you may limit which interface should be used to send and transmit data.

Declaration

[JsonProperty("current_network_interface")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public string CurrentNetworkInterface { get; set; }

Property Value

Type	Description
System.String

DHT

True if DHT is enabled

Declaration

[JsonProperty("dht")]
public bool? DHT { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

DHTPort

DHT port if DHTSameAsBT is false.

Declaration

[JsonProperty("dht_port")]
public int? DHTPort { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

DHTSameAsBT

True if DHT port should match TCP port

Declaration

[JsonProperty("dhtSameAsBT")]
public bool? DHTSameAsBT { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

DoNotCountSlowTorrents

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

Declaration

[JsonProperty("dont_count_slow_torrents")]
public bool? DoNotCountSlowTorrents { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

DownloadLimit

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

Declaration

[JsonProperty("dl_limit")]
public int? DownloadLimit { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

DynamicDnsDomain

Your DDNS domain name.

Declaration

[JsonProperty("dyndns_domain")]
public string DynamicDnsDomain { get; set; }

Property Value

Type	Description
System.String

DynamicDnsEnabled

True if server DNS should be updated dynamically.

Declaration

[JsonProperty("dyndns_enabled")]
public bool? DynamicDnsEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

DynamicDnsPassword

Password for DDNS service.

Declaration

[JsonProperty("dyndns_password")]
public string DynamicDnsPassword { get; set; }

Property Value

Type	Description
System.String

DynamicDnsService

Dynamic DNS service.

Declaration

[JsonProperty("dyndns_service")]
public DynamicDnsService? DynamicDnsService { get; set; }

Property Value

Type	Description
System.Nullable<DynamicDnsService>

DynamicDnsUsername

Username for DDNS service.

Declaration

[JsonProperty("dyndns_username")]
public string DynamicDnsUsername { get; set; }

Property Value

Type	Description
System.String

EnableUTP

True if uTP protocol should be enabled.

Declaration

[JsonProperty("enable_utp")]
[Obsolete("Use BittorrentProtocol property for qBittorrent 4.x")]
public bool? EnableUTP { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Encryption

Encryption mode.

Declaration

[JsonProperty("encryption")]
public Encryption? Encryption { get; set; }

Property Value

Type	Description
System.Nullable<Encryption>

ExportDirectory

Path to directory to copy .torrent files.

Declaration

[JsonProperty("export_dir")]
public string ExportDirectory { get; set; }

Property Value

Type	Description
System.String

ExportDirectoryForFinished

Path to directory to copy finished .torrent files

Declaration

[JsonProperty("export_dir_fin")]
public string ExportDirectoryForFinished { get; set; }

Property Value

Type	Description
System.String

ForceProxy

True if the connections not supported by the proxy are disabled.

Declaration

[JsonProperty("force_proxy")]
[Deprecated("2.3")]
public bool? ForceProxy { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IpFilterEnabled

True if external IP filter should be enabled.

Declaration

[JsonProperty("ip_filter_enabled")]
public bool? IpFilterEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

IpFilterPath

Path to IP filter file (.dat, .p2p, .p2b files are supported).

Declaration

[JsonProperty("ip_filter_path")]
public string IpFilterPath { get; set; }

Property Value

Type	Description
System.String

IpFilterTrackers

True if IP filters are applied to trackers

Declaration

[JsonProperty("ip_filter_trackers")]
public bool? IpFilterTrackers { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

LibtorrentAllowMultipleConnectionsFromSameIp

Determines if connections from the same IP address as existing connections should be rejected or not.

Declaration

[JsonProperty("enable_multi_connections_from_same_ip")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public bool? LibtorrentAllowMultipleConnectionsFromSameIp { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

This option is disabled by default to prevent abusive behavior by peers. It may be useful to allow such connections in cases where simulations are run on the same machine, and all peers in a swarm has the same IP address.

LibtorrentAnnounceIp

The ip address passed along to trackers. If this value is blank, the parameter will be omitted.

Declaration

[JsonProperty("announce_ip")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public string LibtorrentAnnounceIp { get; set; }

Property Value

Type	Description
System.String

LibtorrentAnnounceToAllTiers

Controls how multi tracker torrents are treated.

Declaration

[JsonProperty("announce_to_all_tiers")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public bool? LibtorrentAnnounceToAllTiers { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

When this is set to true, one tracker from each tier is announced to. This is the uTorrent behavior. This is false by default in order to comply with the multi-tracker specification.

See Also

LibtorrentAnnounceToAllTrackers

LibtorrentAnnounceToAllTrackers

Controls how multi tracker torrents are treated.

Declaration

[JsonProperty("announce_to_all_trackers")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public bool? LibtorrentAnnounceToAllTrackers { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

If this is set to true, all trackers in the same tier are announced to in parallel. If all trackers in tier 0 fails, all trackers in tier 1 are announced as well. Otherwise the behavior is as defined by the multi tracker specification.

See Also

LibtorrentAnnounceToAllTiers

LibtorrentAsynchronousIOThreads

I/O threads that libtorrent will use.

Declaration

[JsonProperty("async_io_threads")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentAsynchronousIOThreads { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

The number of threads actually used for SHA-1 hashing is n/4 (where n is the value of the setting), so for maximum performance, especially during torrent recheck, this setting should be set to 4 times the number of hardware threads on your machine. So for example, if your CPU is 4c/4t or 2c/4t, set this to 16, if your CPU is 4c/8t or 8c/8t set this to 32, etc. It is unlikely that setting this any higher than this will bring a performance benefit.

LibtorrentCoalesceReadsAndWrites

When enabled, qbittorrent will allocate separate, contiguous, buffers for read and write calls.

Declaration

[JsonProperty("enable_coalesce_read_write")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public bool? LibtorrentCoalesceReadsAndWrites { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

Only used where writev/readv cannot be used, and will use more RAM but may improve performance.

LibtorrentDiskCache

Amount of data (in MiB) that will remain in RAM before being written to disk. If set to 0, no data will be kept in RAM and instead it will be immediately written to disk (you might see performance impact.)

Declaration

[JsonProperty("disk_cache")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentDiskCache { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

See Also

LibtorrentDiskCacheExpiryInterval

LibtorrentDiskCacheExpiryInterval

The number of seconds from the last cached write to a piece in the write cache, to when it's forcefully flushed to disk.

Declaration

[JsonProperty("disk_cache_ttl")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentDiskCacheExpiryInterval { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

See Also

LibtorrentDiskCache

LibtorrentEmbeddedTrackerPort

The port the embedded tracker should listen on.

Declaration

[JsonProperty("embedded_tracker_port")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentEmbeddedTrackerPort { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

See Also

LibtorrentEnableEmbeddedTracker

LibtorrentEnableEmbeddedTracker

Enable qbittorrent's tracker functionality.

Declaration

[JsonProperty("enable_embedded_tracker")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public bool? LibtorrentEnableEmbeddedTracker { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

It is not a fully-featured bittorrent tracker, but it supports the basic features need for sharing a few torrents.

See Also

LibtorrentEmbeddedTrackerPort

LibtorrentFilePoolSize

The upper limit on the total number of files the session will keep open.

Declaration

[JsonProperty("file_pool_size")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentFilePoolSize { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

The reason why files are left open at all is that some anti virus software hooks on every file close, and scans the file for viruses. Deferring the closing of the files will be the difference between a usable system and a completely hogged down system. Most operating systems also has a limit on the total number of file descriptors a process may have open.

LibtorrentMaxConcurrentHttpAnnounces

Limits the number of concurrent HTTP tracker announces. Once the limit is hit, tracker requests are queued and issued when an outstanding announce completes.

Declaration

[JsonProperty("max_concurrent_http_announces")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.6")]
public int? LibtorrentMaxConcurrentHttpAnnounces { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

LibtorrentOutgoingPortsMax

The end of the range of ports to use for binding outgoing connections to.

Declaration

[JsonProperty("outgoing_ports_max")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentOutgoingPortsMax { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

This property together with LibtorrentOutgoingPortsMin defines the range of ports to use for binding outgoing connections to. The range shouldn't be too small.

The value of 0 disables this setting.

Setting outgoing ports will limit the ability to keep multiple connections to the same client, even for different torrents. It is not recommended to change this setting. Its main purpose is to use it as an escape hatch for cheap routers with QoS capability but can only classify flows based on port numbers. It is a range instead of a single port because of the problems with failing to reconnect to peers if a previous socket to that peer and port is in the waiting state.

See Also

LibtorrentOutgoingPortsMin

LibtorrentOutgoingPortsMin

The start of the range of ports to use for binding outgoing connections to.

Declaration

[JsonProperty("outgoing_ports_min")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentOutgoingPortsMin { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

This property together with LibtorrentOutgoingPortsMax defines the range of ports to use for binding outgoing connections to. The range shouldn't be too small.

The value of 0 disables this setting.

Setting outgoing ports will limit the ability to keep multiple connections to the same client, even for different torrents. It is not recommended to change this setting. Its main purpose is to use it as an escape hatch for cheap routers with QoS capability but can only classify flows based on port numbers. It is a range instead of a single port because of the problems with failing to reconnect to peers if a previous socket to that peer and port is in the waiting state.

See Also

LibtorrentOutgoingPortsMax

LibtorrentOutstandingMemoryWhenCheckingTorrent

The amount of memory (in MiB) to use when checking torrents. Higher numbers give faster rechecks but use more memory.

Declaration

[JsonProperty("checking_memory_use")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentOutstandingMemoryWhenCheckingTorrent { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

LibtorrentPieceExtentAffinity

When this is true, create an affinity for downloading 4 MiB extents of adjacent pieces.

Declaration

[JsonProperty("enable_piece_extent_affinity")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.4.1")]
public bool? LibtorrentPieceExtentAffinity { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

This is an attempt to achieve better disk I/O throughput by downloading larger extents of bytes, for torrents with small piece sizes.

LibtorrentSendBufferLowWatermark

The minimum send buffer target size in kiB.

Declaration

[JsonProperty("send_buffer_low_watermark")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentSendBufferLowWatermark { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

Send buffer includes bytes pending being read from disk.

For good and snappy seeding performance, set this fairly high, to at least fit a few blocks. This is essentially the initial window size which will determine how fast we can ramp up the send rate.

See Also

LibtorrentSendBufferWatermark

LibtorrentSendBufferWatermarkFactor

LibtorrentSendBufferWatermark

The upper limit for the send buffer size in kiB.

Declaration

[JsonProperty("send_buffer_watermark")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentSendBufferWatermark { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

If the send buffer has fewer bytes than this, another 16kiB block will be read into it. If set too small, upload rate capacity will suffer. If set too high, memory will be wasted. The actual watermark may be lower than this in case the upload rate is low.

See Also

LibtorrentSendBufferLowWatermark

LibtorrentSendBufferWatermarkFactor

LibtorrentSendBufferWatermarkFactor

The send buffer watermark factor in percent.

Declaration

[JsonProperty("send_buffer_watermark_factor")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentSendBufferWatermarkFactor { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

The current upload rate to a peer is multiplied by this factor (in percent) to get the send buffer watermark. This product is clamped to the LibtorrentSendBufferWatermark setting so as to not exceed the max. For high speed upload, this should be set to a greater value than 100. For high capacity connections, setting this higher can improve upload performance and disk throughput. Setting it too high may waste RAM and create a bias towards read jobs over write jobs.

See Also

LibtorrentSendBufferWatermark

LibtorrentSendBufferLowWatermark

LibtorrentSendUploadPieceSuggestions

Controls whether or not libtorrent will send out suggest messages to create a bias of its peers to request certain pieces. If enabled, libtorrent will send out suggest messages for the most recent pieces that are in the read cache.

Declaration

[JsonProperty("enable_upload_suggestions")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public bool? LibtorrentSendUploadPieceSuggestions { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

LibtorrentSocketBacklogSize

The number of outstanding incoming connections to queue up while we're not actively waiting for a connection to be accepted.

Declaration

[JsonProperty("socket_backlog_size")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? LibtorrentSocketBacklogSize { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

The default is 5 which should be sufficient for any normal client. If this is a high performance server which expects to receive a lot of connections, or used in a simulator or test, it might make sense to raise this number.

LibtorrentStopTrackerTimeout

The number of seconds to wait when sending a stopped message before considering a tracker to have timed out.

Declaration

[JsonProperty("stop_tracker_timeout")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.4.1")]
public int? LibtorrentStopTrackerTimeout { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

This is usually shorter, to make the client quit faster. If the value is set to 0, the connections to trackers with the stopped event are suppressed.

LibtorrentStrictSuperSeeding

Activate libtorrent's strict mode for super seeding.

Declaration

[JsonProperty("enable_super_seeding")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
[Deprecated("2.5")]
public bool? LibtorrentStrictSuperSeeding { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

When this is set to true, a piece has to have been forwarded to a third peer before another one is handed out. This is the traditional definition of super seeding.

LibtorrentUploadChokingAlgorithm

Controls the seeding unchoke behavior.

Declaration

[JsonProperty("upload_choking_algorithm")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public SeedChokingAlgorithm? LibtorrentUploadChokingAlgorithm { get; set; }

Property Value

Type	Description
System.Nullable<SeedChokingAlgorithm>

LibtorrentUploadSlotsBehavior

Specifies which algorithm to use to determine which peers to unchoke.

Declaration

[JsonProperty("upload_slots_behavior")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public ChokingAlgorithm? LibtorrentUploadSlotsBehavior { get; set; }

Property Value

Type	Description
System.Nullable<ChokingAlgorithm>

LibtorrentUseOSCache

When enabled, files are opened normally, with the OS caching reads and writes.

Declaration

[JsonProperty("enable_os_cache")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3", MaxVersion = "2.8.19")]
public bool? LibtorrentUseOSCache { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Remarks

Enable for better performance, disable if you also disabled libtorrent's read cache, or to help preventing the operating system from growing its file cache indefinitely, or if you want to prevent qbittorrent from potentially evicting all other processes' cache (which may result in lower perceived system responsiveness).

LibtorrentUtpTcpMixedModeAlgorithm

Determines how to treat TCP connections when there are uTP connections.

Declaration

[JsonProperty("utp_tcp_mixed_mode")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public UtpTcpMixedModeAlgorithm? LibtorrentUtpTcpMixedModeAlgorithm { get; set; }

Property Value

Type	Description
System.Nullable<UtpTcpMixedModeAlgorithm>

Remarks

Since uTP is designed to yield to TCP, there's an inherent problem when using swarms that have both TCP and uTP connections. If nothing is done, uTP connections would often be starved out for bandwidth by the TCP connections. This mode is called PreferTcp in qBittorrent.

The PeerProportional mode on the other hand, simply looks at the current throughput and rate limits all TCP connections to their proportional share based on how many of the connections are TCP. This works best if uTP connections are not rate limited by the global rate limiter.

LimitLAN

True if DownloadLimit and UploadLimit should be applied to peers on the LAN

Declaration

[JsonProperty("limit_lan_peers")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public bool? LimitLAN { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

LimitTcpOverhead

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

Declaration

[JsonProperty("limit_tcp_overhead")]
public bool? LimitTcpOverhead { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

LimitUTPRate

True if DownloadLimit and UploadLimit should be applied to uTP connections.

Declaration

[JsonProperty("limit_utp_rate")]
public bool? LimitUTPRate { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ListenOnIPv6Address

Allows qBittorrent to listen on IPv6 address in addition to the old, standard IPv4.

Declaration

[JsonProperty("listen_on_ipv6_address")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
[Deprecated("2.4")]
public bool? ListenOnIPv6Address { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ListenPort

Port for incoming connections.

Declaration

[JsonProperty("listen_port")]
public int? ListenPort { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Locale

Currently selected language

Declaration

[JsonProperty("locale")]
public string Locale { get; set; }

Property Value

Type	Description
System.String

LocalPeerDiscovery

True if local peer discovery is enabled

Declaration

[JsonProperty("lsd")]
public bool? LocalPeerDiscovery { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

MailNotificationAuthenticationEnabled

True if SMTP server requires authentication

Declaration

[JsonProperty("mail_notification_auth_enabled")]
public bool? MailNotificationAuthenticationEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

MailNotificationEmailAddress

E-mail address to send notifications to.

Declaration

[JsonProperty("mail_notification_email")]
public string MailNotificationEmailAddress { get; set; }

Property Value

Type	Description
System.String

MailNotificationEnabled

True if e-mail notification should be enabled.

Declaration

[JsonProperty("mail_notification_enabled")]
public bool? MailNotificationEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

MailNotificationPassword

Password for SMTP authentication.

Declaration

[JsonProperty("mail_notification_password")]
public string MailNotificationPassword { get; set; }

Property Value

Type	Description
System.String

MailNotificationSender

E-mail where notifications should originate from

Declaration

[JsonProperty("mail_notification_sender")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public string MailNotificationSender { get; set; }

Property Value

Type	Description
System.String

MailNotificationSmtpServer

SMTP server for e-mail notifications.

Declaration

[JsonProperty("mail_notification_smtp")]
public string MailNotificationSmtpServer { get; set; }

Property Value

Type	Description
System.String

MailNotificationSslEnabled

True if SMTP server requires SSL connection.

Declaration

[JsonProperty("mail_notification_ssl_enabled")]
public bool? MailNotificationSslEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

MailNotificationUsername

Username for SMTP authentication.

Declaration

[JsonProperty("mail_notification_username")]
public string MailNotificationUsername { get; set; }

Property Value

Type	Description
System.String

MaxActiveDownloads

Maximum number of active simultaneous downloads

Declaration

[JsonProperty("max_active_downloads")]
public int? MaxActiveDownloads { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MaxActiveTorrents

Maximum number of active simultaneous downloads and uploads

Declaration

[JsonProperty("max_active_torrents")]
public int? MaxActiveTorrents { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MaxActiveUploads

Maximum number of active simultaneous uploads

Declaration

[JsonProperty("max_active_uploads")]
public int? MaxActiveUploads { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MaxConnections

Maximum global number of simultaneous connections.

Declaration

[JsonProperty("max_connec")]
public int? MaxConnections { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MaxConnectionsPerTorrent

Maximum number of simultaneous connections per torrent.

Declaration

[JsonProperty("max_connec_per_torrent")]
public int? MaxConnectionsPerTorrent { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MaxInactiveSeedingTime

Maximal inactive seeding time in minutes.

Declaration

[JsonProperty("max_inactive_seeding_time")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.9.2")]
public int? MaxInactiveSeedingTime { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MaxInactiveSeedingTimeEnabled

True if maximal inactive seeding time is enabled.

Declaration

[JsonProperty("max_inactive_seeding_time_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.9.2")]
public bool? MaxInactiveSeedingTimeEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

MaxRatio

Get the global share ratio limit

Declaration

[JsonProperty("max_ratio")]
public double? MaxRatio { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

MaxRatioAction

Action performed when a torrent reaches the maximum share ratio.

Declaration

[JsonProperty("max_ratio_act")]
public MaxRatioAction? MaxRatioAction { get; set; }

Property Value

Type	Description
System.Nullable<MaxRatioAction>

MaxRatioEnabled

True if share ratio limit is enabled

Declaration

[JsonProperty("max_ratio_enabled")]
public bool? MaxRatioEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

MaxSeedingTime

Maximal seeding time in minutes.

Declaration

[JsonProperty("max_seeding_time")]
public int? MaxSeedingTime { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MaxSeedingTimeEnabled

True if maximal seeding time is enabled.

Declaration

[JsonProperty("max_seeding_time_enabled")]
public bool? MaxSeedingTimeEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

MaxUploads

Maximum number of upload slots.

Declaration

[JsonProperty("max_uploads")]
public int? MaxUploads { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MaxUploadsPerTorrent

Maximum number of upload slots per torrent

Declaration

[JsonProperty("max_uploads_per_torrent")]
public int? MaxUploadsPerTorrent { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

PeerExchange

True if peer exchange PeX is enabled.

Declaration

[JsonProperty("pex")]
public bool? PeerExchange { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

PreallocateAll

True if file preallocation should take place, otherwise sparse files are used.

Declaration

[JsonProperty("preallocate_all")]
public bool? PreallocateAll { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ProxyAddress

Proxy IP address or domain name.

Declaration

[JsonProperty("proxy_ip")]
public string ProxyAddress { get; set; }

Property Value

Type	Description
System.String

ProxyAuthenticationEnabled

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

Declaration

[JsonProperty("proxy_auth_enabled")]
[Obsolete("Use ProxyType instead.")]
public bool? ProxyAuthenticationEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ProxyBittorrent

True if proxy should be used for BitTorrent purposes.

Declaration

[JsonProperty("proxy_bittorrent")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.9.1")]
public bool? ProxyBittorrent { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ProxyHostnameLookup

True if proxy should be used to perform hostname lookup.

Declaration

[JsonProperty("proxy_hostname_lookup")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.8.18")]
public bool? ProxyHostnameLookup { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ProxyMisc

True if proxy should be used for general purposes.

Declaration

[JsonProperty("proxy_misc")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.9.1")]
public bool? ProxyMisc { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ProxyPassword

Password for proxy authentication.

Declaration

[JsonProperty("proxy_password")]
public string ProxyPassword { get; set; }

Property Value

Type	Description
System.String

ProxyPeerConnections

True if peer and web seed connections should be proxified.

Declaration

[JsonProperty("proxy_peer_connections")]
public bool? ProxyPeerConnections { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ProxyPort

Proxy port.

Declaration

[JsonProperty("proxy_port")]
public int? ProxyPort { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

ProxyRss

True if proxy should be used for RSS purposes.

Declaration

[JsonProperty("proxy_rss")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.9.1")]
public bool? ProxyRss { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ProxyTorrentsOnly

True if proxy should be used only for torrents.

Declaration

[JsonProperty("proxy_torrents_only")]
[ApiLevel(ApiLevel.V2, MaxVersion = "2.8.19")]
public bool? ProxyTorrentsOnly { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ProxyType

Proxy type.

Declaration

[JsonProperty("proxy_type")]
public ProxyType? ProxyType { get; set; }

Property Value

Type	Description
System.Nullable<ProxyType>

ProxyUsername

Username for proxy authentication.

Declaration

[JsonProperty("proxy_username")]
public string ProxyUsername { get; set; }

Property Value

Type	Description
System.String

QueueingEnabled

True if torrent queuing is enabled

Declaration

[JsonProperty("queueing_enabled")]
public bool? QueueingEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

RandomPort

True if the port is randomly selected

Declaration

[JsonProperty("random_port")]
public bool? RandomPort { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

RecheckCompletedTorrents

When enabled, after the torrent is completely downloaded a recheck operation is performed on the torrent.

Declaration

[JsonProperty("recheck_completed_torrents")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public bool? RecheckCompletedTorrents { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ResolvePeerCountries

When enabled, qBittorrent tries to lookup the originating country of each peer using GeoIP database.

Declaration

[JsonProperty("resolve_peer_countries")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public bool? ResolvePeerCountries { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

RssAutoDownloadingEnabled

Enable auto-downloading of torrents from the RSS feeds.

Declaration

[JsonProperty("rss_auto_downloading_enabled")]
public bool? RssAutoDownloadingEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

RssDownloadRepackProperEpisodes

Enables downloading REPACK/PROPER episodes.

Declaration

[JsonProperty("rss_download_repack_proper_episodes")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.5.1")]
public bool? RssDownloadRepackProperEpisodes { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

RssMaxArticlesPerFeed

Max stored articles per RSS feed.

Declaration

[JsonProperty("rss_max_articles_per_feed")]
public int? RssMaxArticlesPerFeed { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

RssProcessingEnabled

Enable processing of RSS feeds.

Declaration

[JsonProperty("rss_processing_enabled")]
public bool? RssProcessingEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

RssRefreshInterval

RSS refresh interval.

Declaration

[JsonProperty("rss_refresh_interval")]
public uint? RssRefreshInterval { get; set; }

Property Value

Type	Description
System.Nullable<System.UInt32>

RssSmartEpisodeFilters

Smart episode filters.

Declaration

[JsonProperty("rss_smart_episode_filters")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.5.1")]
[JsonConverter(typeof(SeparatedStringToListConverter), new object[]{"\n"})]
public IList<string> RssSmartEpisodeFilters { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

SavePath

Default save path for torrents, separated by slashes

Declaration

[JsonProperty("save_path")]
public string SavePath { get; set; }

Property Value

Type	Description
System.String

SaveResumeDataInterval

Duration in minutes on which the resume data is saved to the disk.

Declaration

[JsonProperty("save_resume_data_interval")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? SaveResumeDataInterval { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

ScanDirectories

List of watch folders to add torrent automatically.

Declaration

[JsonProperty("scan_dirs")]
public IDictionary<string, SaveLocation> ScanDirectories { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, SaveLocation>

ScheduleFromHour

Scheduler starting hour.

Declaration

[JsonProperty("schedule_from_hour")]
public int? ScheduleFromHour { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

ScheduleFromMinute

Scheduler starting minute.

Declaration

[JsonProperty("schedule_from_min")]
public int? ScheduleFromMinute { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

SchedulerDays

Scheduler days.

Declaration

[JsonProperty("scheduler_days")]
public SchedulerDay? SchedulerDays { get; set; }

Property Value

Type	Description
System.Nullable<SchedulerDay>

SchedulerEnabled

True if alternative limits should be applied according to schedule

Declaration

[JsonProperty("scheduler_enabled")]
public bool? SchedulerEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ScheduleToHour

Scheduler ending hour.

Declaration

[JsonProperty("schedule_to_hour")]
public int? ScheduleToHour { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

ScheduleToMinute

Scheduler ending minute.

Declaration

[JsonProperty("schedule_to_min")]
public int? ScheduleToMinute { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

SlowTorrentDownloadRateThreshold

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

Declaration

[JsonProperty("slow_torrent_dl_rate_threshold")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public int? SlowTorrentDownloadRateThreshold { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

SlowTorrentInactiveTime

Time in seconds a torrent should be inactive before considered "slow"

Declaration

[JsonProperty("slow_torrent_inactive_timer")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public int? SlowTorrentInactiveTime { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

SlowTorrentUploadRateThreshold

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

Declaration

[JsonProperty("slow_torrent_ul_rate_threshold")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public int? SlowTorrentUploadRateThreshold { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

TempPath

Path for incomplete torrents, separated by slashes

Declaration

[JsonProperty("temp_path")]
public string TempPath { get; set; }

Property Value

Type	Description
System.String

TempPathEnabled

True if folder for incomplete torrents is enabled

Declaration

[JsonProperty("temp_path_enabled")]
public bool? TempPathEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

TorrentContentLayout

The default torrent content layout.

Declaration

[JsonProperty("torrent_content_layout")]
[JsonConverter(typeof(StringEnumConverter))]
[ApiLevel(ApiLevel.V2, MinVersion = "2.7")]
public TorrentContentLayout? TorrentContentLayout { get; set; }

Property Value

Type	Description
System.Nullable<TorrentContentLayout>

TorrentFileAutoDeleteMode

Declaration

[JsonProperty("auto_delete_mode")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2.0")]
public TorrentFileAutoDeleteMode? TorrentFileAutoDeleteMode { get; set; }

Property Value

Type	Description
System.Nullable<TorrentFileAutoDeleteMode>

UploadLimit

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

Declaration

[JsonProperty("up_limit")]
public int? UploadLimit { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

UpnpEnabled

True if UPnP/NAT-PMP is enabled.

Declaration

[JsonProperty("upnp")]
public bool? UpnpEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

WebUIAddress

WebUI IP address. Use * to accept connections on any IP address.

Declaration

[JsonProperty("web_ui_address")]
public string WebUIAddress { get; set; }

Property Value

Type	Description
System.String

WebUIBanDuration

The duration (in seconds) the client will be banned for after WebUIMaxAuthenticationFailures failed authentication attempts.

Declaration

[JsonProperty("web_ui_ban_duration")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.4.1")]
public int? WebUIBanDuration { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

WebUIClickjackingProtection

True if WebUI clickjacking protection is enabled

Declaration

[JsonProperty("web_ui_clickjacking_protection_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.0.2")]
public bool? WebUIClickjackingProtection { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

WebUICsrfProtection

True if WebUI CSRF protection is enabled

Declaration

[JsonProperty("web_ui_csrf_protection_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.0.2")]
public bool? WebUICsrfProtection { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

WebUICustomHttpHeaders

Custom HTTP headers to be used for Web UI.

Declaration

[JsonProperty("web_ui_custom_http_headers")]
[JsonConverter(typeof(SeparatedStringToListConverter), new object[]{"\n"})]
[ApiLevel(ApiLevel.V2, MinVersion = "2.5.1")]
public IList<string> WebUICustomHttpHeaders { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Remarks

Each header must be specified as a key-value pair separated by a colon, i.e.HEADER:VALUE. The headers must be separated by a new-line character (\n).

WebUICustomHttpHeadersEnabled

True if custom HTTP headers are enabled for Web UI.

Declaration

[JsonProperty("web_ui_use_custom_http_headers_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.5.1")]
public bool? WebUICustomHttpHeadersEnabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

WebUIDomain

WebUI domain. Use * to accept connections on any domain.

Declaration

[JsonProperty("web_ui_domain_list")]
public string WebUIDomain { get; set; }

Property Value

Type	Description
System.String

WebUIHostHeaderValidation

True if WebUI host header validation is enabled

Declaration

[JsonProperty("web_ui_host_header_validation_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.2")]
public bool? WebUIHostHeaderValidation { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

WebUIHttps

True if WebUI HTTPS access is enabled.

Declaration

[JsonProperty("use_https")]
public bool? WebUIHttps { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

WebUIMaxAuthenticationFailures

The number of the failed authentication attempt after which the client will be banned.

Declaration

[JsonProperty("web_ui_max_auth_fail_count")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.4.1")]
public int? WebUIMaxAuthenticationFailures { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

See Also

WebUIBanDuration

WebUIPassword

WebUI password.

Declaration

[JsonIgnore]
public string WebUIPassword { get; set; }

Property Value

Type	Description
System.String

Remarks

This property should be used for setting password. If a Preferences object is retrieved as server response, this property will be null.

WebUIPasswordHash

MD5 hash of WebUI password.

Declaration

[JsonIgnore]
public string WebUIPasswordHash { get; set; }

Property Value

Type	Description
System.String

Remarks

This property can be used to get the MD5 hash of the current WebUI password. It is ignored when sending requests to the server.

WebUIPort

WebUI port.

Declaration

[JsonProperty("web_ui_port")]
public int? WebUIPort { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

WebUISecureCookie

True if Secure attribute is set on cookie when using HTTPS

Declaration

[JsonProperty("web_ui_secure_cookie_enabled")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.4.1")]
public bool? WebUISecureCookie { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

WebUISessionTimeout

Web UI session timeout in seconds

Declaration

[JsonProperty("web_ui_session_timeout")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public int? WebUISessionTimeout { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

WebUISslCertificate

SSL certificate contents (this is a not a path).

Declaration

[JsonProperty("ssl_cert")]
[Deprecated("2.3", Description = "Use WebUISslCertificatePath on API 2.3 or later.")]
public string WebUISslCertificate { get; set; }

Property Value

Type	Description
System.String

WebUISslCertificatePath

SSL certificate file path on the server.

Declaration

[JsonProperty("web_ui_https_cert_path")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public string WebUISslCertificatePath { get; set; }

Property Value

Type	Description
System.String

WebUISslKey

SSL keyfile contents (this is a not a path).

Declaration

[JsonProperty("ssl_key")]
[Deprecated("2.3", Description = "Use WebUISslKeyPath on API 2.3 or later.")]
public string WebUISslKey { get; set; }

Property Value

Type	Description
System.String

WebUISslKeyPath

SSL key file path on the server.

Declaration

[JsonProperty("web_ui_https_key_path")]
[ApiLevel(ApiLevel.V2, MinVersion = "2.3")]
public string WebUISslKeyPath { get; set; }

Property Value

Type	Description
System.String

WebUIUpnp

True if UPnP is used for the WebUI port.

Declaration

[JsonProperty("web_ui_upnp")]
public bool? WebUIUpnp { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

WebUIUsername

WebUI username

Declaration

[JsonProperty("web_ui_username")]
public string WebUIUsername { get; set; }

Property Value

Type	Description
System.String