v1

latestOpenAPI 3.0.12026-07-134082641.7 MB
Configuration

Gets application configuration.

get/System/Configuration

Response

Application configuration returned.

LogFileRetentionDaysinteger

Gets or sets the number of days we should retain log files.

IsStartupWizardCompletedboolean

Gets or sets a value indicating whether this instance is first run.

CachePathstring nullable

Gets or sets the cache path.

PreviousVersionStrstring nullable

Gets or sets the stringified PreviousVersion to be stored/loaded, because System.Version itself isn't xml-serializable.

EnableUPnPboolean

Gets or sets a value indicating whether to enable automatic port forwarding.

EnableMetricsboolean

Gets or sets a value indicating whether to enable prometheus metrics exporting.

PublicPortinteger

Gets or sets the public mapped port.

UPnPCreateHttpPortMapboolean

Gets or sets a value indicating whether the http port should be mapped as part of UPnP automatic port forwarding.

UDPPortRangestring nullable

Gets or sets client udp port range.

EnableIPV6boolean

Gets or sets a value indicating whether IPV6 capability is enabled.

EnableIPV4boolean

Gets or sets a value indicating whether IPV4 capability is enabled.

EnableSSDPTracingboolean

Gets or sets a value indicating whether detailed ssdp logs are sent to the console/log. "Emby.Dlna": "Debug" must be set in logging.default.json for this property to work.

SSDPTracingFilterstring nullable

Gets or sets a value indicating whether an IP address is to be used to filter the detailed ssdp logs that are being sent to the console/log. If the setting "Emby.Dlna": "Debug" msut be set in logging.default.json for this property to work.

UDPSendCountinteger

Gets or sets the number of times SSDP UDP messages are sent.

UDPSendDelayinteger

Gets or sets the delay between each groups of SSDP messages (in ms).

IgnoreVirtualInterfacesboolean

Gets or sets a value indicating whether address names that match MediaBrowser.Model.Configuration.ServerConfiguration.VirtualInterfaceNames should be Ignore for the purposes of binding.

VirtualInterfaceNamesstring nullable

Gets or sets a value indicating the interfaces that should be ignored. The list can be comma separated. <seealso cref="P:MediaBrowser.Model.Configuration.ServerConfiguration.IgnoreVirtualInterfaces" />.

GatewayMonitorPeriodinteger

Gets or sets the time (in seconds) between the pings of SSDP gateway monitor.

EnableMultiSocketBindingboolean

Gets a value indicating whether multi-socket binding is available.

TrustAllIP6Interfacesboolean

Gets or sets a value indicating whether all IPv6 interfaces should be treated as on the internal network. Depending on the address range implemented ULA ranges might not be used.

HDHomerunPortRangestring nullable

Gets or sets the ports that HDHomerun uses.

PublishedServerUriBySubnetstring[] nullable

Gets or sets PublishedServerUri to advertise for specific subnets.

AutoDiscoveryTracingboolean

Gets or sets a value indicating whether Autodiscovery tracing is enabled.

AutoDiscoveryboolean

Gets or sets a value indicating whether Autodiscovery is enabled.

PublicHttpsPortinteger

Gets or sets the public HTTPS port.

HttpServerPortNumberinteger

Gets or sets the HTTP server port number.

HttpsPortNumberinteger

Gets or sets the HTTPS server port number.

EnableHttpsboolean

Gets or sets a value indicating whether to use HTTPS.

EnableNormalizedItemByNameIdsboolean
CertificatePathstring nullable

Gets or sets the filesystem path of an X.509 certificate to use for SSL.

CertificatePasswordstring nullable

Gets or sets the password required to access the X.509 certificate data in the file specified by MediaBrowser.Model.Configuration.ServerConfiguration.CertificatePath.

IsPortAuthorizedboolean

Gets or sets a value indicating whether this instance is port authorized.

QuickConnectAvailableboolean

Gets or sets a value indicating whether quick connect is available for use on this server.

EnableRemoteAccessboolean

Gets or sets a value indicating whether access outside of the LAN is permitted.

EnableCaseSensitiveItemIdsboolean

Gets or sets a value indicating whether [enable case sensitive item ids].

DisableLiveTvChannelUserDataNameboolean
MetadataPathstring nullable

Gets or sets the metadata path.

MetadataNetworkPathstring nullable
PreferredMetadataLanguagestring nullable

Gets or sets the preferred metadata language.

MetadataCountryCodestring nullable

Gets or sets the metadata country code.

SortReplaceCharactersstring[] nullable

Gets or sets characters to be replaced with a ' ' in strings to create a sort name.

SortRemoveCharactersstring[] nullable

Gets or sets characters to be removed from strings to create a sort name.

SortRemoveWordsstring[] nullable

Gets or sets words to be removed from strings to create a sort name.

MinResumePctinteger

Gets or sets the minimum percentage of an item that must be played in order for playstate to be updated.

MaxResumePctinteger

Gets or sets the maximum percentage of an item that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched.

MinResumeDurationSecondsinteger

Gets or sets the minimum duration that an item must have in order to be eligible for playstate updates..

MinAudiobookResumeinteger

Gets or sets the minimum minutes of a book that must be played in order for playstate to be updated.

MaxAudiobookResumeinteger

Gets or sets the remaining minutes of a book that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched.

LibraryMonitorDelayinteger

Gets or sets the delay in seconds that we will wait after a file system change to try and discover what has been added/removed Some delay is necessary with some items because their creation is not atomic. It involves the creation of several different directories and files.

EnableDashboardResponseCachingboolean

Gets or sets a value indicating whether [enable dashboard response caching]. Allows potential contributors without visual studio to modify production dashboard code and test changes.

ImageSavingConvention'Legacy' | 'Compatible'
SkipDeserializationForBasicTypesboolean
ServerNamestring nullable
BaseUrlstring nullable
UICulturestring nullable
SaveMetadataHiddenboolean
RemoteClientBitrateLimitinteger
EnableFolderViewboolean
EnableGroupingIntoCollectionsboolean
DisplaySpecialsWithinSeasonsboolean
LocalNetworkSubnetsstring[] nullable

Gets or sets the subnets that are deemed to make up the LAN.

LocalNetworkAddressesstring[] nullable

Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be used.

CodecsUsedstring[] nullable
EnableExternalContentInSuggestionsboolean
RequireHttpsboolean

Gets or sets a value indicating whether the server should force connections over HTTPS.

EnableNewOmdbSupportboolean
RemoteIPFilterstring[] nullable

Gets or sets the filter for remote IP connectivity. Used in conjuntion with <seealso cref="P:MediaBrowser.Model.Configuration.ServerConfiguration.IsRemoteIPFilterBlacklist" />.

IsRemoteIPFilterBlacklistboolean

Gets or sets a value indicating whether <seealso cref="P:MediaBrowser.Model.Configuration.ServerConfiguration.RemoteIPFilter" /> contains a blacklist or a whitelist. Default is a whitelist.

ImageExtractionTimeoutMsinteger
EnableSimpleArtistDetectionboolean
UninstalledPluginsstring[] nullable
EnableSlowResponseWarningboolean

Gets or sets a value indicating whether slow server responses should be logged as a warning.

SlowResponseThresholdMsinteger

Gets or sets the threshold for the slow response time warning in ms.

CorsHostsstring[] nullable

Gets or sets the cors hosts.

KnownProxiesstring[] nullable

Gets or sets the known proxies.

ActivityLogRetentionDaysinteger nullable

Gets or sets the number of days we should retain activity logs.

LibraryScanFanoutConcurrencyinteger

Gets or sets the how the library scan fans out.

LibraryMetadataRefreshConcurrencyinteger

Gets or sets the how many metadata refreshes can run concurrently.

RemoveOldPluginsboolean

Gets or sets a value indicating whether older plugins should automatically be deleted from the plugin folder.

DisablePluginImagesboolean

Gets or sets a value indicating whether plugin image should be disabled.