Catalog

Strict service readiness.

Operator-facing hugging-bay.health.v1 readiness. Returns 503 unless dependencies, representative reads, and verified downloads are ready.

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/readiness

Request

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

Query parameters

compat'containment'

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

Response

Ready

schemaVersion'hugging-bay.health.v1' required
okboolean required
readyboolean required
degradedboolean
reasonstring
liveness'ok' required
service'hugging-bay' required

Changes

No recorded changes to this operation across all 1 revision of this API.