Readiness probe with database introspection.
const url = 'https://example.com/status';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/statusAuthorizations
Section titled “Authorizations”- None
Responses
Section titled “ Responses ”JSON envelope for a successful status check.
JSON envelope for a successful status check.
object
The instance claim state (#994): "claimed" or "unclaimed".
Omitted if the iam.instance_claim query fails.
Database connection and version details.
object
Active connections and pool utilization.
object
TLS connection status for the database pool.
object
The origins this instance accepts SSH challenge signatures for.
object
Operator-configured public origins (--public-origin,
HENCEFORTH_PUBLIC_ORIGINS), canonical, in the order given. A
configured loopback origin is accepted only from a loopback peer.
Whether the implicit loopback default is active: true only in
--dev / --dev --no-auth with no configured origin. Production never
has it.
The only port the implicit loopback default accepts (the bound port).
Present only when implicit_loopback is true.
Examplegenerated
{ "claim": "example", "database": { "connections": { "active": 1, "max": 1, "pool_idle": 1, "pool_size": 1 }, "latency_ms": 1, "name": "example", "server_version": "example", "ssl": { "bits": 1, "cipher": "example", "enabled": true, "version": "example" } }, "metadata_path": "example", "public_origins": { "configured": [ "example" ], "implicit_loopback": true, "implicit_loopback_port": 1 }, "status": "example"}JSON envelope for a failed status check.
JSON envelope for a failed status check.
object
The origins this instance accepts SSH challenge signatures for. Held in memory from startup, so it is reported even when the database is down.
object
Operator-configured public origins (--public-origin,
HENCEFORTH_PUBLIC_ORIGINS), canonical, in the order given. A
configured loopback origin is accepted only from a loopback peer.
Whether the implicit loopback default is active: true only in
--dev / --dev --no-auth with no configured origin. Production never
has it.
The only port the implicit loopback default accepts (the bound port).
Present only when implicit_loopback is true.
Examplegenerated
{ "error": "example", "metadata_path": "example", "public_origins": { "configured": [ "example" ], "implicit_loopback": true, "implicit_loopback_port": 1 }, "status": "example"}default
Section titled “default”Structured error envelope (SPEC-DATA-0006): {"errors": [{"domain", "scope", "target", "code", "message"}, ...]}. domain (added #950 D9) names the subsystem that produced the entry (data, metadata, apply, git, auth, iam, hfx, or api for a transport-level failure with no domain error behind it) and is always present.
The top-level response body. Wraps a non-empty list of [ErrorEntry].
object
The error entries making up the envelope. Always non-empty.
One entry in the error envelope.
Carries a [Domain] naming the subsystem that produced it, an anchoring
[ErrorScope], an optional target that disambiguates within the
scope, a stable SCREAMING_SNAKE_CASE code, and a human-readable
English message. See SPEC-DATA-0006 for the full envelope contract.
object
Machine-readable, stable, SCREAMING_SNAKE_CASE identifier.
Which subsystem produced this entry. Always serialized.
data::error::DataError – record CRUD, validation, queries.
server::routes::metadata::error::MetadataError – the metadata
write API (module/object/field/screen PUT and POST).
server::apply::ApplyError – the metadata apply/plan pipeline.
server::git::GitError – the git-backed metadata repository.
auth::error::AuthError – JWT and credential authentication.
server::routes::iam::error::IamError – principal and credential
management (IAM handlers still emit Domain::Data for genuine
request-body field validation, which stays DataError).
server::routes::hfx::error::HfxError – HFX parse/emit.
Module packages (.hfmod, #1165): package format, signature and
compatibility refusals, and the install lifecycle that consumes them.
A transport-level ApiError built directly (forbidden,
not_found, internal, service_unavailable), with no
<Domain>Error behind it.
HFX source location for an HFX_PARSE entry.
Emitted as the extra location field on the entry JSON when present.
The line/column are 1-based. The frame is the offending source line
extracted verbatim from the input.
object
1-based column within the line, measured in UTF-16 code units of the prefix so browser-side editors can consume it directly.
The offending source line text, when available.
1-based line number within the source text.
Server-authored English message. Not part of the API contract; may change across releases without notice.
The key of the validation rule that failed, when the code is
RULE_FAILED. None for all other codes. Skipped during
serialization when absent so it does not appear on unrelated
entries (same pattern as location).
Field key for field scope, record id for record scope, null
otherwise. Always serialized, even when null.
Example
{ "errors": [ { "domain": "data", "scope": "field" } ]}