cyphermed.api.system.health_check

def sync_detailed( *, client: Union[cyphermed.client.AuthenticatedClient, cyphermed.client.Client]) -> cyphermed.types.Response[cyphermed.models.health_info.HealthInfo]:

Health Check

Returns 200 OK if the server is healthy

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[HealthInfo]

def sync( *, client: Union[cyphermed.client.AuthenticatedClient, cyphermed.client.Client]) -> Optional[cyphermed.models.health_info.HealthInfo]:

Health Check

Returns 200 OK if the server is healthy

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: HealthInfo

async def asyncio_detailed( *, client: Union[cyphermed.client.AuthenticatedClient, cyphermed.client.Client]) -> cyphermed.types.Response[cyphermed.models.health_info.HealthInfo]:

Health Check

Returns 200 OK if the server is healthy

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[HealthInfo]

async def asyncio( *, client: Union[cyphermed.client.AuthenticatedClient, cyphermed.client.Client]) -> Optional[cyphermed.models.health_info.HealthInfo]:

Health Check

Returns 200 OK if the server is healthy

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: HealthInfo