jellyfin.generated.api_10_11.StartupApi

All URIs are relative to http://localhost

Method	HTTP request	Description
complete_wizard	POST /Startup/Complete	Completes the startup wizard.
get_first_user	GET /Startup/User	Gets the first user.
get_first_user2	GET /Startup/FirstUser	Gets the first user.
get_startup_configuration	GET /Startup/Configuration	Gets the initial startup wizard configuration.
set_remote_access	POST /Startup/RemoteAccess	Sets remote access and UPnP.
update_initial_configuration	POST /Startup/Configuration	Sets the initial startup wizard configuration.
update_startup_user	POST /Startup/User	Sets the user name and password.

complete_wizard

complete_wizard()

Completes the startup wizard.

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

    try:
        # Completes the startup wizard.
        api_instance.complete_wizard()
    except Exception as e:
        print("Exception when calling StartupApi->complete_wizard: %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: text/html

HTTP response details

Status code	Description	Response headers
204	Startup wizard completed.	-
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_first_user

StartupUserDto get_first_user()

Gets the first user.

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.startup_user_dto import StartupUserDto
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.StartupApi(api_client)

    try:
        # Gets the first user.
        api_response = api_instance.get_first_user()
        print("The response of StartupApi->get_first_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StartupApi->get_first_user: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StartupUserDto

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	Initial user 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_first_user2

StartupUserDto get_first_user2()

Gets the first user.

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.startup_user_dto import StartupUserDto
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.StartupApi(api_client)

    try:
        # Gets the first user.
        api_response = api_instance.get_first_user2()
        print("The response of StartupApi->get_first_user2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StartupApi->get_first_user2: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StartupUserDto

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	Initial user 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_startup_configuration

StartupConfigurationDto get_startup_configuration()

Gets the initial startup wizard configuration.

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.startup_configuration_dto import StartupConfigurationDto
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.StartupApi(api_client)

    try:
        # Gets the initial startup wizard configuration.
        api_response = api_instance.get_startup_configuration()
        print("The response of StartupApi->get_startup_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StartupApi->get_startup_configuration: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StartupConfigurationDto

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	Initial startup wizard configuration 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]

set_remote_access

set_remote_access(startup_remote_access_dto)

Sets remote access and UPnP.

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.startup_remote_access_dto import StartupRemoteAccessDto
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.StartupApi(api_client)
    startup_remote_access_dto = jellyfin.generated.api_10_11.StartupRemoteAccessDto() # StartupRemoteAccessDto | The startup remote access dto.

    try:
        # Sets remote access and UPnP.
        api_instance.set_remote_access(startup_remote_access_dto)
    except Exception as e:
        print("Exception when calling StartupApi->set_remote_access: %s\n" % e)

Parameters

Name	Type	Description	Notes
startup_remote_access_dto	StartupRemoteAccessDto	The startup remote access dto.

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	Configuration 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]

update_initial_configuration

update_initial_configuration(startup_configuration_dto)

Sets the initial startup wizard configuration.

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.startup_configuration_dto import StartupConfigurationDto
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.StartupApi(api_client)
    startup_configuration_dto = jellyfin.generated.api_10_11.StartupConfigurationDto() # StartupConfigurationDto | The updated startup configuration.

    try:
        # Sets the initial startup wizard configuration.
        api_instance.update_initial_configuration(startup_configuration_dto)
    except Exception as e:
        print("Exception when calling StartupApi->update_initial_configuration: %s\n" % e)

Parameters

Name	Type	Description	Notes
startup_configuration_dto	StartupConfigurationDto	The updated startup configuration.

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	Configuration 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]

update_startup_user

update_startup_user(startup_user_dto=startup_user_dto)

Sets the user name and password.

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.startup_user_dto import StartupUserDto
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.StartupApi(api_client)
    startup_user_dto = jellyfin.generated.api_10_11.StartupUserDto() # StartupUserDto | The DTO containing username and password. (optional)

    try:
        # Sets the user name and password.
        api_instance.update_startup_user(startup_user_dto=startup_user_dto)
    except Exception as e:
        print("Exception when calling StartupApi->update_startup_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
startup_user_dto	StartupUserDto	The DTO containing username and password.	[optional]

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	Updated user name and password.	-
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]