jellyfin.generated.api_10_11.DashboardApi

All URIs are relative to http://localhost

Method	HTTP request	Description
get_configuration_pages	GET /web/ConfigurationPages	Gets the configuration pages.
get_dashboard_configuration_page	GET /web/ConfigurationPage	Gets a dashboard configuration page.

get_configuration_pages

List[ConfigurationPageInfo] get_configuration_pages(enable_in_main_menu=enable_in_main_menu)

Gets the configuration pages.

Example

• Api Key Authentication (CustomAuthentication):

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.configuration_page_info import ConfigurationPageInfo
from jellyfin.generated.api_10_11.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_11.DashboardApi(api_client)
    enable_in_main_menu = True # bool | Whether to enable in the main menu. (optional)

    try:
        # Gets the configuration pages.
        api_response = api_instance.get_configuration_pages(enable_in_main_menu=enable_in_main_menu)
        print("The response of DashboardApi->get_configuration_pages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DashboardApi->get_configuration_pages: %s\n" % e)

Parameters

Name	Type	Description	Notes
enable_in_main_menu	bool	Whether to enable in the main menu.	[optional]

Return type

List[ConfigurationPageInfo]

Authorization

CustomAuthentication

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	ConfigurationPages returned.	-
404	Server still loading.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.
401	Unauthorized	-
403	Forbidden	-

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

get_dashboard_configuration_page

bytearray get_dashboard_configuration_page(name=name)

Gets a dashboard configuration page.

Example

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.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"
)

# 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_11.DashboardApi(api_client)
    name = 'name_example' # str | The name of the page. (optional)

    try:
        # Gets a dashboard configuration page.
        api_response = api_instance.get_dashboard_configuration_page(name=name)
        print("The response of DashboardApi->get_dashboard_configuration_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DashboardApi->get_dashboard_configuration_page: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The name of the page.	[optional]

Return type

bytearray

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	ConfigurationPage returned.	-
404	Plugin configuration page not found.	-
503	The server is currently starting or is temporarily not available.	* Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available.

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