jellyfin.generated.api_10_11.PackageApi

All URIs are relative to http://localhost

Method	HTTP request	Description
cancel_package_installation	DELETE /Packages/Installing/{packageId}	Cancels a package installation.
get_package_info	GET /Packages/{name}	Gets a package by name or assembly GUID.
get_packages	GET /Packages	Gets available packages.
get_repositories	GET /Repositories	Gets all package repositories.
install_package	POST /Packages/Installed/{name}	Installs a package.
set_repositories	POST /Repositories	Sets the enabled and existing package repositories.

cancel_package_installation

cancel_package_installation(package_id)

Cancels a package installation.

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.PackageApi(api_client)
    package_id = 'package_id_example' # str | Installation Id.

    try:
        # Cancels a package installation.
        api_instance.cancel_package_installation(package_id)
    except Exception as e:
        print("Exception when calling PackageApi->cancel_package_installation: %s\n" % e)

Parameters

Name	Type	Description	Notes
package_id	str	Installation Id.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

Content-Type: Not defined
Accept: text/html

HTTP response details

Status code	Description	Response headers
204	Installation cancelled.	-
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_package_info

PackageInfo get_package_info(name, assembly_guid=assembly_guid)

Gets a package by name or assembly GUID.

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.package_info import PackageInfo
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.PackageApi(api_client)
    name = 'name_example' # str | The name of the package.
    assembly_guid = 'assembly_guid_example' # str | The GUID of the associated assembly. (optional)

    try:
        # Gets a package by name or assembly GUID.
        api_response = api_instance.get_package_info(name, assembly_guid=assembly_guid)
        print("The response of PackageApi->get_package_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PackageApi->get_package_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The name of the package.
assembly_guid	str	The GUID of the associated assembly.	[optional]

Return type

PackageInfo

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	Package 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.
401	Unauthorized	-
403	Forbidden	-

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

get_packages

List[PackageInfo] get_packages()

Gets available packages.

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.package_info import PackageInfo
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.PackageApi(api_client)

    try:
        # Gets available packages.
        api_response = api_instance.get_packages()
        print("The response of PackageApi->get_packages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PackageApi->get_packages: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[PackageInfo]

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	Available packages returned.	-
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_repositories

List[RepositoryInfo] get_repositories()

Gets all package repositories.

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.repository_info import RepositoryInfo
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.PackageApi(api_client)

    try:
        # Gets all package repositories.
        api_response = api_instance.get_repositories()
        print("The response of PackageApi->get_repositories:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PackageApi->get_repositories: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[RepositoryInfo]

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	Package repositories returned.	-
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]

install_package

install_package(name, assembly_guid=assembly_guid, version=version, repository_url=repository_url)

Installs a package.

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.PackageApi(api_client)
    name = 'name_example' # str | Package name.
    assembly_guid = 'assembly_guid_example' # str | GUID of the associated assembly. (optional)
    version = 'version_example' # str | Optional version. Defaults to latest version. (optional)
    repository_url = 'repository_url_example' # str | Optional. Specify the repository to install from. (optional)

    try:
        # Installs a package.
        api_instance.install_package(name, assembly_guid=assembly_guid, version=version, repository_url=repository_url)
    except Exception as e:
        print("Exception when calling PackageApi->install_package: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Package name.
assembly_guid	str	GUID of the associated assembly.	[optional]
version	str	Optional version. Defaults to latest version.	[optional]
repository_url	str	Optional. Specify the repository to install from.	[optional]

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	Package found.	-
404	Package 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.
401	Unauthorized	-
403	Forbidden	-

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

set_repositories

set_repositories(repository_info)

Sets the enabled and existing package repositories.

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.repository_info import RepositoryInfo
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.PackageApi(api_client)
    repository_info = [jellyfin.generated.api_10_11.RepositoryInfo()] # List[RepositoryInfo] | The list of package repositories.

    try:
        # Sets the enabled and existing package repositories.
        api_instance.set_repositories(repository_info)
    except Exception as e:
        print("Exception when calling PackageApi->set_repositories: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository_info	List[RepositoryInfo]	The list of package repositories.

Return type

void (empty response body)

Authorization

CustomAuthentication

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: text/html

HTTP response details

Status code	Description	Response headers
204	Package repositories saved.	-
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]