< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.ConfigurationController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/ConfigurationController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 24
Coverable lines: 24
Total lines: 145
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 2
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100 1/23/2026 - 12:11:06 AM Line coverage: 0% (0/24) Branch coverage: 0% (0/2) Total lines: 1641/29/2026 - 12:13:32 AM Line coverage: 0% (0/24) Branch coverage: 0% (0/2) Total lines: 1444/27/2026 - 12:15:04 AM Line coverage: 0% (0/24) Branch coverage: 0% (0/2) Total lines: 145 1/23/2026 - 12:11:06 AM Line coverage: 0% (0/24) Branch coverage: 0% (0/2) Total lines: 1641/29/2026 - 12:13:32 AM Line coverage: 0% (0/24) Branch coverage: 0% (0/2) Total lines: 1444/27/2026 - 12:15:04 AM Line coverage: 0% (0/24) Branch coverage: 0% (0/2) Total lines: 145

Coverage delta

Coverage delta 1 -1

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
GetConfiguration()100%210%
UpdateConfiguration(...)100%210%
GetNamedConfiguration(...)100%210%
UpdateNamedConfiguration(...)0%620%
GetDefaultMetadataOptions()100%210%
UpdateBrandingConfiguration(...)100%210%

File(s)

/srv/git/jellyfin/Jellyfin.Api/Controllers/ConfigurationController.cs

#LineLine coverage
 1using System;
 2using System.ComponentModel.DataAnnotations;
 3using System.Net.Mime;
 4using System.Text.Json;
 5using Jellyfin.Api.Attributes;
 6using Jellyfin.Extensions.Json;
 7using MediaBrowser.Common.Api;
 8using MediaBrowser.Controller.Configuration;
 9using MediaBrowser.Controller.MediaEncoding;
 10using MediaBrowser.Model.Branding;
 11using MediaBrowser.Model.Configuration;
 12using Microsoft.AspNetCore.Authorization;
 13using Microsoft.AspNetCore.Http;
 14using Microsoft.AspNetCore.Mvc;
 15
 16namespace Jellyfin.Api.Controllers;
 17
 18/// <summary>
 19/// Configuration Controller.
 20/// </summary>
 21[Route("System")]
 22[Authorize]
 23[Tags("System")]
 24public class ConfigurationController : BaseJellyfinApiController
 25{
 26    private readonly IServerConfigurationManager _configurationManager;
 27    private readonly IMediaEncoder _mediaEncoder;
 28
 029    private readonly JsonSerializerOptions _serializerOptions = JsonDefaults.Options;
 30
 31    /// <summary>
 32    /// Initializes a new instance of the <see cref="ConfigurationController"/> class.
 33    /// </summary>
 34    /// <param name="configurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</param>
 35    /// <param name="mediaEncoder">Instance of the <see cref="IMediaEncoder"/> interface.</param>
 036    public ConfigurationController(
 037        IServerConfigurationManager configurationManager,
 038        IMediaEncoder mediaEncoder)
 39    {
 040        _configurationManager = configurationManager;
 041        _mediaEncoder = mediaEncoder;
 042    }
 43
 44    /// <summary>
 45    /// Gets application configuration.
 46    /// </summary>
 47    /// <response code="200">Application configuration returned.</response>
 48    /// <returns>Application configuration.</returns>
 49    [HttpGet("Configuration")]
 50    [ProducesResponseType(StatusCodes.Status200OK)]
 51    public ActionResult<ServerConfiguration> GetConfiguration()
 52    {
 053        return _configurationManager.Configuration;
 54    }
 55
 56    /// <summary>
 57    /// Updates application configuration.
 58    /// </summary>
 59    /// <param name="configuration">Configuration.</param>
 60    /// <response code="204">Configuration updated.</response>
 61    /// <returns>Update status.</returns>
 62    [HttpPost("Configuration")]
 63    [Authorize(Policy = Policies.RequiresElevation)]
 64    [ProducesResponseType(StatusCodes.Status204NoContent)]
 65    public ActionResult UpdateConfiguration([FromBody, Required] ServerConfiguration configuration)
 66    {
 067        _configurationManager.ReplaceConfiguration(configuration);
 068        return NoContent();
 69    }
 70
 71    /// <summary>
 72    /// Gets a named configuration.
 73    /// </summary>
 74    /// <param name="key">Configuration key.</param>
 75    /// <response code="200">Configuration returned.</response>
 76    /// <returns>Configuration.</returns>
 77    [HttpGet("Configuration/{key}")]
 78    [ProducesResponseType(StatusCodes.Status200OK)]
 79    [ProducesFile(MediaTypeNames.Application.Json)]
 80    public ActionResult<object> GetNamedConfiguration([FromRoute, Required] string key)
 81    {
 082        return _configurationManager.GetConfiguration(key);
 83    }
 84
 85    /// <summary>
 86    /// Updates named configuration.
 87    /// </summary>
 88    /// <param name="key">Configuration key.</param>
 89    /// <param name="configuration">Configuration.</param>
 90    /// <response code="204">Named configuration updated.</response>
 91    /// <returns>Update status.</returns>
 92    [HttpPost("Configuration/{key}")]
 93    [Authorize(Policy = Policies.RequiresElevation)]
 94    [ProducesResponseType(StatusCodes.Status204NoContent)]
 95    public ActionResult UpdateNamedConfiguration([FromRoute, Required] string key, [FromBody, Required] JsonDocument con
 96    {
 097        var configurationType = _configurationManager.GetConfigurationType(key);
 098        var deserializedConfiguration = configuration.Deserialize(configurationType, _serializerOptions);
 99
 0100        if (deserializedConfiguration is null)
 101        {
 0102            throw new ArgumentException("Body doesn't contain a valid configuration");
 103        }
 104
 0105        _configurationManager.SaveConfiguration(key, deserializedConfiguration);
 0106        return NoContent();
 107    }
 108
 109    /// <summary>
 110    /// Gets a default MetadataOptions object.
 111    /// </summary>
 112    /// <response code="200">Metadata options returned.</response>
 113    /// <returns>Default MetadataOptions.</returns>
 114    [HttpGet("Configuration/MetadataOptions/Default")]
 115    [Authorize(Policy = Policies.RequiresElevation)]
 116    [ProducesResponseType(StatusCodes.Status200OK)]
 117    public ActionResult<MetadataOptions> GetDefaultMetadataOptions()
 118    {
 0119        return new MetadataOptions();
 120    }
 121
 122    /// <summary>
 123    /// Updates branding configuration.
 124    /// </summary>
 125    /// <param name="configuration">Branding configuration.</param>
 126    /// <response code="204">Branding configuration updated.</response>
 127    /// <returns>Update status.</returns>
 128    [HttpPost("Configuration/Branding")]
 129    [Authorize(Policy = Policies.RequiresElevation)]
 130    [ProducesResponseType(StatusCodes.Status204NoContent)]
 131    public ActionResult UpdateBrandingConfiguration([FromBody, Required] BrandingOptionsDto configuration)
 132    {
 133        // Get the current branding configuration to preserve SplashscreenLocation
 0134        var currentBranding = (BrandingOptions)_configurationManager.GetConfiguration("branding");
 135
 136        // Update only the properties from BrandingOptionsDto
 0137        currentBranding.LoginDisclaimer = configuration.LoginDisclaimer;
 0138        currentBranding.CustomCss = configuration.CustomCss;
 0139        currentBranding.SplashscreenEnabled = configuration.SplashscreenEnabled;
 140
 0141        _configurationManager.SaveConfiguration("branding", currentBranding);
 142
 0143        return NoContent();
 144    }
 145}