system.health
Liveness check.
Answers { ok: true } when the worker is serving requests. No credential, no dependencies probed: this is liveness, not readiness.
openemail.system.health(options?: CallOptions): ApiPromise<SystemHealthResult>It calls GET /health: Liveness check in the API reference. The operation is public: the client sends it without its credential.
Example
const result = await openemail.system.health()Options
It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
Awaited, it is the API's JSON, SystemHealthResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
503 | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |
A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.
Types
SystemHealthResult
/** What `system.health` answers. */
type SystemHealthResult = {
ok: true
}