jellyfin.generated.api_10_10.ConfigurationApi

All URIs are relative to http://localhost

Method	HTTP request	Description
get_configuration	GET /System/Configuration	Gets application configuration.
get_default_metadata_options	GET /System/Configuration/MetadataOptions/Default	Gets a default MetadataOptions object.
get_named_configuration	GET /System/Configuration/{key}	Gets a named configuration.
update_configuration	POST /System/Configuration	Updates application configuration.
update_named_configuration	POST /System/Configuration/{key}	Updates named configuration.

get_configuration

ServerConfiguration get_configuration()

Gets application configuration.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_10
from jellyfin.generated.api_10_10 import ApiClient, Configuration
from jellyfin.generated.api_10_10.models.server_configuration import ServerConfiguration
from jellyfin.generated.api_10_10.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_10.ConfigurationApi(api_client)

    try:
        # Gets application configuration.
        api_response = api_instance.get_configuration()
        print("The response of ConfigurationApi->get_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConfigurationApi->get_configuration: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ServerConfiguration

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase"

HTTP response details

Status code	Description	Response headers
200	Application configuration returned.	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_default_metadata_options

MetadataOptions get_default_metadata_options()

Gets a default MetadataOptions object.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_10
from jellyfin.generated.api_10_10 import ApiClient, Configuration
from jellyfin.generated.api_10_10.models.metadata_options import MetadataOptions
from jellyfin.generated.api_10_10.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_10.ConfigurationApi(api_client)

    try:
        # Gets a default MetadataOptions object.
        api_response = api_instance.get_default_metadata_options()
        print("The response of ConfigurationApi->get_default_metadata_options:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConfigurationApi->get_default_metadata_options: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MetadataOptions

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase"

HTTP response details

Status code	Description	Response headers
200	Metadata options returned.	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_named_configuration

bytearray get_named_configuration(key)

Gets a named configuration.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_10
from jellyfin.generated.api_10_10 import ApiClient, Configuration
from jellyfin.generated.api_10_10.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_10.ConfigurationApi(api_client)
    key = 'key_example' # str | Configuration key.

    try:
        # Gets a named configuration.
        api_response = api_instance.get_named_configuration(key)
        print("The response of ConfigurationApi->get_named_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConfigurationApi->get_named_configuration: %s\n" % e)

Parameters

Name	Type	Description	Notes
key	str	Configuration key.

Return type

bytearray

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Configuration returned.	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_configuration

update_configuration(server_configuration)

Updates application configuration.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_10
from jellyfin.generated.api_10_10 import ApiClient, Configuration
from jellyfin.generated.api_10_10.models.server_configuration import ServerConfiguration
from jellyfin.generated.api_10_10.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_10.ConfigurationApi(api_client)
    server_configuration = jellyfin.generated.api_10_10.ServerConfiguration() # ServerConfiguration | Configuration.

    try:
        # Updates application configuration.
        api_instance.update_configuration(server_configuration)
    except Exception as e:
        print("Exception when calling ConfigurationApi->update_configuration: %s\n" % e)

Parameters

Name	Type	Description	Notes
server_configuration	ServerConfiguration	Configuration.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Configuration updated.	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_named_configuration

update_named_configuration(key, body)

Updates named configuration.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_10
from jellyfin.generated.api_10_10 import ApiClient, Configuration
from jellyfin.generated.api_10_10.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
    host = "http://localhost"
)

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_10.ConfigurationApi(api_client)
    key = 'key_example' # str | Configuration key.
    body = None # object | Configuration.

    try:
        # Updates named configuration.
        api_instance.update_named_configuration(key, body)
    except Exception as e:
        print("Exception when calling ConfigurationApi->update_named_configuration: %s\n" % e)

Parameters

Name	Type	Description	Notes
key	str	Configuration key.
body	object	Configuration.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Named configuration updated.	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]