Hanzo
OpenapiDomain

Reports registrar reachability honestly: ok only when the wholesale credentials…

Reports registrar reachability honestly: ok only when the wholesale credentials are present AND name.com accepted them on a live call made while you…

GET /v1/domain/health

Addresshttps://api.hanzo.ai/v1/domain/health
MethodGET
Operationget_domain_health
AuthAuthorization: Bearer $HANZO_API_KEY

Reports registrar reachability honestly: ok only when the wholesale credentials are present AND name.com accepted them on a live call made while you waited.

Missing credentials or an unreachable registrar is 503 carrying configured, reachable and the reason, so an operator reads the blocker instead of guessing at it. It takes no principal, like every subsystem health probe.

Request

GET /v1/domain/health takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200reachabilityok
503reachabilityservice unavailable

200 body — 7 fields.

FieldInTypeAlwaysDescription
configuredbodybooleanConfigured is whether the wholesale credentials are present at all.
envbodystringEnv is the registrar environment. It is the fact that decides whether money moves: only "prod" reaches the live, billable registrar — anything else, including…
errorbodystringError is the blocker, so an operator reads it instead of guessing at it.
reachablebodybooleanReachable is whether the registrar accepted those credentials on a live call made while the caller waited.
registrarbodystringRegistrar names the wholesale registrar behind it.
servicebodystringService names the subsystem answering.
statusbodystringStatus is "ok" when a live call succeeded, else "degraded".

Failure carries the platform error shape — see Errors.

Examples

hanzo domain health

Domain API · All Hanzo APIs · Interactive reference

How is this guide?

On this page