API referenceresources
ovok_sdk.resources.health
The `ovok.health` namespace: the API health check.
- Stable unknown
- Release candidate since 0.1.0-rc.4
- Development since 0.1.0-dev.25+2ba84b0
The ovok.health namespace: the API health check.
HealthResource
HealthResource(http: HttpClient)Reads the API health check.
Created by Ovok; access it as ovok.health. It sends no credentials.
check()
check() -> dict[str, Any]Read the API health response.
The route always answers 200, so read ok in the body, not the status.
Returns
dict[str, Any]: The health body;oktells whether the API is healthy.
Examples
>>> ovok.health.check()["ok"]
TrueLast updated on