Catalog

Cheap process liveness and initialization.

Memory-only process health, independent of database and admin load. ready means process initialization only. Require /api/readiness for dependency checks and mutation preflights.

Inputs. Path, query and header fields are listed below. No request body is required.

Outputs. See each status below for its media type, schema and headers. A missing record or unavailable capability is not a successful empty result.

Errors. API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.

Rate limits. Public read budgets apply by client IP and route group. This operation can have a smaller route-specific budget. Read Retry-After on 429 or retryable 503 responses.

get/api/health

Request

  • Base URL: https://huggingbay.xyz
  • URL: https://huggingbay.xyz/api/health
  • Auth: none declared

Query parameters

compat'containment'

Deprecated legacy response block opt-in for one release only.

Response

Process initialized and not shutting down

schemaVersion'hugging-bay.health.v1' required
okboolean required
readyboolean required
liveness'ok' | 'stopping' required
service'hugging-bay' required
probe'liveness'
livenessOnlyunknown
readinessScope'process-initialization' required
readinessAuthority'/api/readiness'
dependencyReadiness'/api/readiness' required
notestring

Liveness-only disclaimer: ok/200 do not imply readiness; poll /api/readiness (503 while unready).

Changes

No recorded changes to this operation across all 2 revisions of this API.