jellyfin.generated.api_10_11.SystemApi

All URIs are relative to http://localhost

Method	HTTP request	Description
get_endpoint_info	GET /System/Endpoint	Gets information about the request endpoint.
get_log_file	GET /System/Logs/Log	Gets a log file.
get_ping_system	GET /System/Ping	Pings the system.
get_public_system_info	GET /System/Info/Public	Gets public information about the server.
get_server_logs	GET /System/Logs	Gets a list of available server log files.
get_system_info	GET /System/Info	Gets information about the server.
get_system_storage	GET /System/Info/Storage	Gets information about the server.
post_ping_system	POST /System/Ping	Pings the system.
restart_application	POST /System/Restart	Restarts the application.
shutdown_application	POST /System/Shutdown	Shuts down the application.

get_endpoint_info

EndPointInfo get_endpoint_info()

Gets information about the request endpoint.

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.end_point_info import EndPointInfo
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.SystemApi(api_client)

    try:
        # Gets information about the request endpoint.
        api_response = api_instance.get_endpoint_info()
        print("The response of SystemApi->get_endpoint_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->get_endpoint_info: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

EndPointInfo

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	Information retrieved.	-
403	User does not have permission to get endpoint information.	-
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	-

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

get_log_file

bytearray get_log_file(name)

Gets a log file.

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.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.SystemApi(api_client)
    name = 'name_example' # str | The name of the log file to get.

    try:
        # Gets a log file.
        api_response = api_instance.get_log_file(name)
        print("The response of SystemApi->get_log_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->get_log_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The name of the log file to get.

Return type

bytearray

Authorization

CustomAuthentication

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Log file retrieved.	-
403	User does not have permission to get log files.	-
404	Could not find a log file with the name.	-
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	-

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

get_ping_system

str get_ping_system()

Pings the system.

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.SystemApi(api_client)

    try:
        # Pings the system.
        api_response = api_instance.get_ping_system()
        print("The response of SystemApi->get_ping_system:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->get_ping_system: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

No authorization required

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	Information retrieved.	-
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]

get_public_system_info

PublicSystemInfo get_public_system_info()

Gets public information about the server.

Example

import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.public_system_info import PublicSystemInfo
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.SystemApi(api_client)

    try:
        # Gets public information about the server.
        api_response = api_instance.get_public_system_info()
        print("The response of SystemApi->get_public_system_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->get_public_system_info: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

PublicSystemInfo

Authorization

No authorization required

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	Information retrieved.	-
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]

get_server_logs

List[LogFile] get_server_logs()

Gets a list of available server log files.

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.log_file import LogFile
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.SystemApi(api_client)

    try:
        # Gets a list of available server log files.
        api_response = api_instance.get_server_logs()
        print("The response of SystemApi->get_server_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->get_server_logs: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[LogFile]

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	Information retrieved.	-
403	User does not have permission to get server logs.	-
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	-

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

get_system_info

SystemInfo get_system_info()

Gets information about the server.

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.system_info import SystemInfo
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.SystemApi(api_client)

    try:
        # Gets information about the server.
        api_response = api_instance.get_system_info()
        print("The response of SystemApi->get_system_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->get_system_info: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

SystemInfo

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	Information retrieved.	-
403	User does not have permission to retrieve information.	-
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	-

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

get_system_storage

SystemStorageDto get_system_storage()

Gets information about the server.

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.system_storage_dto import SystemStorageDto
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.SystemApi(api_client)

    try:
        # Gets information about the server.
        api_response = api_instance.get_system_storage()
        print("The response of SystemApi->get_system_storage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->get_system_storage: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

SystemStorageDto

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	Information retrieved.	-
403	User does not have permission to retrieve information.	-
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	-

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

post_ping_system

str post_ping_system()

Pings the system.

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.SystemApi(api_client)

    try:
        # Pings the system.
        api_response = api_instance.post_ping_system()
        print("The response of SystemApi->post_ping_system:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->post_ping_system: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

No authorization required

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	Information retrieved.	-
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]

restart_application

restart_application()

Restarts the application.

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.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.SystemApi(api_client)

    try:
        # Restarts the application.
        api_instance.restart_application()
    except Exception as e:
        print("Exception when calling SystemApi->restart_application: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

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
204	Server restarted.	-
403	User does not have permission to restart server.	-
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	-

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

shutdown_application

shutdown_application()

Shuts down the application.

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.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.SystemApi(api_client)

    try:
        # Shuts down the application.
        api_instance.shutdown_application()
    except Exception as e:
        print("Exception when calling SystemApi->shutdown_application: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

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
204	Server shut down.	-
403	User does not have permission to shutdown server.	-
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	-

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