kavita_client.api.health.get_api_health

Module Contents

Functions

asyncio	No-op method that just returns Ok. Used for health checks in Docker containers.
asyncio_detailed	No-op method that just returns Ok. Used for health checks in Docker containers.
sync	No-op method that just returns Ok. Used for health checks in Docker containers.
sync_detailed	No-op method that just returns Ok. Used for health checks in Docker containers.

API

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

No-op method that just returns Ok. Used for health checks in Docker containers.

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

No-op method that just returns Ok. Used for health checks in Docker containers.

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

No-op method that just returns Ok. Used for health checks in Docker containers.

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

No-op method that just returns Ok. Used for health checks in Docker containers.

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]