kavita_client.api.settings.get_api_settings_base_url

Module Contents

Functions

asyncio	Returns the base url for this instance (if set)
asyncio_detailed	Returns the base url for this instance (if set)
sync	Returns the base url for this instance (if set)
sync_detailed	Returns the base url for this instance (if set)

API

async kavita_client.api.settings.get_api_settings_base_url.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → str | None

Returns the base url for this instance (if set)

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

str

async kavita_client.api.settings.get_api_settings_base_url.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[str]

Returns the base url for this instance (if set)

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[str]

kavita_client.api.settings.get_api_settings_base_url.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → str | None

Returns the base url for this instance (if set)

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

str

kavita_client.api.settings.get_api_settings_base_url.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[str]

Returns the base url for this instance (if set)

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[str]