qcrboxapiclient.api.admin.healthz¶
- async qcrboxapiclient.api.admin.healthz.asyncio(*, client)¶
Health check
Check the health of the QCrBox registry.
- 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.
- Return type:
Optional[QCrBoxHealthResponse]- Returns:
QCrBoxHealthResponse
- Parameters:
client (AuthenticatedClient | Client)
- async qcrboxapiclient.api.admin.healthz.asyncio_detailed(*, client)¶
Health check
Check the health of the QCrBox registry.
- 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.
- Return type:
Response[QCrBoxHealthResponse]- Returns:
Response[QCrBoxHealthResponse]
- Parameters:
client (AuthenticatedClient | Client)
- qcrboxapiclient.api.admin.healthz.sync(*, client)¶
Health check
Check the health of the QCrBox registry.
- 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.
- Return type:
Optional[QCrBoxHealthResponse]- Returns:
QCrBoxHealthResponse
- Parameters:
client (AuthenticatedClient | Client)
- qcrboxapiclient.api.admin.healthz.sync_detailed(*, client)¶
Health check
Check the health of the QCrBox registry.
- 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.
- Return type:
Response[QCrBoxHealthResponse]- Returns:
Response[QCrBoxHealthResponse]
- Parameters:
client (AuthenticatedClient | Client)