# ovok.health

Canonical page: https://docs.ovok.com/web-sdk/core/namespaces/health

A health probe. It needs no sign-in and grants no access to project data.

## Check the API [#check-the-api]

```ts
const health = await ovok.health.check();

if (!health.ok) {
  throw new Error('Ovok API is not healthy');
}
```

- The route always answers 200. Read `ok`, not the HTTP status.
- `dependencies` holds an `ok` flag per dependency, by name.
- `version`, `buildEnv` and `commitHash` are filled when the server reports them, and can be `null`.
- Calls `GET healthcheck`.

## Reference [#reference]

- [health API reference](/web-sdk/core/reference/core/health): every method and type.
- [Get started](/web-sdk/core/getting-started)
- [Errors and retries](/web-sdk/core/errors-and-retries)