kavita_client.api.plugin.get_api_plugin_version

Module Contents

Functions

asyncio	Returns the version of the Kavita install
asyncio_detailed	Returns the version of the Kavita install
sync	Returns the version of the Kavita install
sync_detailed	Returns the version of the Kavita install

API

async kavita_client.api.plugin.get_api_plugin_version.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, api_key: str) → str | None

Returns the version of the Kavita install

This will log unauthorized requests to Security log

Args:

api_key (str):

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.plugin.get_api_plugin_version.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, api_key: str) → kavita_client.types.Response[str]

Returns the version of the Kavita install

This will log unauthorized requests to Security log

Args:

api_key (str):

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.plugin.get_api_plugin_version.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, api_key: str) → str | None

Returns the version of the Kavita install

This will log unauthorized requests to Security log

Args:

api_key (str):

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.plugin.get_api_plugin_version.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, api_key: str) → kavita_client.types.Response[str]

Returns the version of the Kavita install

This will log unauthorized requests to Security log

Args:

api_key (str):

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]