Server Configuration

API endpoints for managing Jellyfin server configuration

Overview

The Server Configuration API provides endpoints to retrieve and update server configuration settings. These endpoints allow administrators to manage server behavior, metadata options, branding, and other system-wide settings.

Get Server Configuration

Retrieves the complete server configuration.

Endpoint

GET /System/Configuration

Authentication

Required. Any authenticated user can retrieve the configuration.

Response

Returns a ServerConfiguration object with all server settings.

Show Configuration Fields

ServerName · string

The name of the server

EnableMetrics · boolean · default: "false"

Whether to enable Prometheus metrics exporting

QuickConnectAvailable · boolean · default: "true"

Whether Quick Connect is available for use

MetadataPath · string

The path where metadata is stored

PreferredMetadataLanguage · string · default: "en"

The preferred language for metadata

MetadataCountryCode · string · default: "US"

The country code for metadata

UICulture · string · default: "en-US"

The UI culture/locale

MinResumePct · integer · default: "5"

Minimum percentage of an item that must be played to update playstate

MaxResumePct · integer · default: "90"

Maximum percentage that can be played while still saving playstate

MinResumeDurationSeconds · integer · default: "300"

Minimum duration (in seconds) for an item to be eligible for playstate updates

MinAudiobookResume · integer · default: "5"

Minimum minutes of an audiobook that must be played to update playstate

MaxAudiobookResume · integer · default: "5"

Remaining minutes of an audiobook that can be played while still saving playstate

InactiveSessionThreshold · integer · default: "0"

Threshold in minutes after which inactive sessions are closed (0 to disable)

LibraryMonitorDelay · integer · default: "60"

Delay in seconds to wait after filesystem changes before discovering additions/removals

LibraryUpdateDuration · integer · default: "30"

Duration in seconds to wait after library update before executing notification

CacheSize · integer

Maximum number of items to cache

MetadataOptions · array

Metadata configuration for different item types

RemoteClientBitrateLimit · integer

Bitrate limit for remote clients

EnableFolderView · boolean · default: "false"

Whether to enable folder view

EnableGroupingMoviesIntoCollections · boolean · default: "false"

Whether to group movies into collections

EnableGroupingShowsIntoCollections · boolean · default: "false"

Whether to group TV shows into collections

DisplaySpecialsWithinSeasons · boolean · default: "true"

Whether to display special episodes within seasons

EnableExternalContentInSuggestions · boolean · default: "true"

Whether to include external content in suggestions

EnableSlowResponseWarning · boolean · default: "true"

Whether to log slow server responses as warnings

SlowResponseThresholdMs · integer · default: "500"

Threshold for slow response time warning (in milliseconds)

CorsHosts · array · default: "[\"*\"]"

Array of allowed CORS hosts

ActivityLogRetentionDays · integer · default: "30"

Number of days to retain activity logs

LibraryScanFanoutConcurrency · integer

How the library scan fans out for concurrent operations

LibraryMetadataRefreshConcurrency · integer

How many metadata refreshes can run concurrently

AllowClientLogUpload · boolean · default: "true"

Whether clients are allowed to upload logs

DummyChapterDuration · integer

Dummy chapter duration in seconds (0 or less to disable)

ChapterImageResolution · string · default: "MatchSource"

Resolution for chapter images

ParallelImageEncodingLimit · integer

Limit for parallel image encoding

CastReceiverApplications · array

List of cast receiver applications

TrickplayOptions · object

Configuration for trickplay (preview thumbnails)

EnableLegacyAuthorization · boolean · default: "false"

Whether to enable old authorization methods

Example Request

curl -X GET "https://your-jellyfin-server/System/Configuration" \
  -H "Authorization: MediaBrowser Token=YOUR_API_KEY"

Example Response

{
  "ServerName": "My Jellyfin Server",
  "EnableMetrics": false,
  "QuickConnectAvailable": true,
  "MetadataPath": "/config/metadata",
  "PreferredMetadataLanguage": "en",
  "MetadataCountryCode": "US",
  "UICulture": "en-US",
  "MinResumePct": 5,
  "MaxResumePct": 90,
  "MinResumeDurationSeconds": 300,
  "LibraryMonitorDelay": 60,
  "EnableFolderView": false,
  "DisplaySpecialsWithinSeasons": true,
  "CorsHosts": ["*"],
  "ActivityLogRetentionDays": 30,
  "AllowClientLogUpload": true
}

Response Codes

• 200 - Configuration retrieved successfully

---

Update Server Configuration

Updates the complete server configuration.

Endpoint

POST /System/Configuration

Authentication

Required. User must have elevated permissions (administrator).

Request Body

Send a complete ServerConfiguration object with the desired settings.

configuration · object · required

Complete ServerConfiguration object with updated values

Example Request

curl -X POST "https://your-jellyfin-server/System/Configuration" \
  -H "Authorization: MediaBrowser Token=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ServerName": "My Updated Server",
    "EnableMetrics": true,
    "PreferredMetadataLanguage": "en",
    "MetadataCountryCode": "US",
    "MinResumePct": 5,
    "MaxResumePct": 90
  }'

Response Codes

• 204 - Configuration updated successfully
• 403 - User does not have permission to update configuration

---

Get Named Configuration

Retrieves a specific named configuration section.

Endpoint

GET /System/Configuration/{key}

Authentication

Required.

Path Parameters

key · string · required

The configuration key/section name (e.g., “branding”, “encoding”)

Response

Returns the configuration object for the specified key.

Example Request

curl -X GET "https://your-jellyfin-server/System/Configuration/branding" \
  -H "Authorization: MediaBrowser Token=YOUR_API_KEY"

Example Response

{
  "LoginDisclaimer": "Welcome to My Jellyfin Server",
  "CustomCss": "",
  "SplashscreenEnabled": false
}

Response Codes

• 200 - Configuration retrieved successfully

---

Update Named Configuration

Updates a specific named configuration section.

Endpoint

POST /System/Configuration/{key}

Authentication

Required. User must have elevated permissions (administrator).

Path Parameters

key · string · required

The configuration key/section name

Request Body

configuration · object · required

Configuration object with updated values

Example Request

curl -X POST "https://your-jellyfin-server/System/Configuration/branding" \
  -H "Authorization: MediaBrowser Token=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "LoginDisclaimer": "Welcome!",
    "CustomCss": "body { background-color: #000; }",
    "SplashscreenEnabled": true
  }'

Response Codes

• 204 - Configuration updated successfully
• 403 - User does not have permission to update configuration

---

Get Default Metadata Options

Retrieves the default MetadataOptions object.

Endpoint

GET /System/Configuration/MetadataOptions/Default

Authentication

Required. User must have elevated permissions (administrator).

Response

Returns a default MetadataOptions object.

Example Request

curl -X GET "https://your-jellyfin-server/System/Configuration/MetadataOptions/Default" \
  -H "Authorization: MediaBrowser Token=YOUR_API_KEY"

Example Response

{
  "ItemType": "",
  "DisabledMetadataSavers": [],
  "LocalMetadataReaderOrder": [],
  "DisabledMetadataFetchers": [],
  "MetadataFetcherOrder": [],
  "DisabledImageFetchers": [],
  "ImageFetcherOrder": []
}

Response Codes

• 200 - Default metadata options retrieved successfully
• 403 - User does not have permission

---

Update Branding Configuration

Updates the branding configuration for the server.

Endpoint

POST /System/Configuration/Branding

Authentication

Required. User must have elevated permissions (administrator).

Request Body

LoginDisclaimer · string

Custom text to display on the login page

CustomCss · string

Custom CSS to apply to the web interface

SplashscreenEnabled · boolean

Whether to enable the custom splashscreen

Example Request

curl -X POST "https://your-jellyfin-server/System/Configuration/Branding" \
  -H "Authorization: MediaBrowser Token=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "LoginDisclaimer": "Welcome to My Custom Server!",
    "CustomCss": ".header { color: blue; }",
    "SplashscreenEnabled": true
  }'

Response Codes

• 204 - Branding configuration updated successfully
• 403 - User does not have permission to update branding configuration

---

Notes

• Configuration changes may require a server restart to take full effect
• Always retrieve the current configuration before updating to avoid overwriting unintended settings
• Some configuration options affect server performance and should be adjusted carefully
• Branding configuration updates only modify the specified properties and preserve other settings