Hanzo
OpenapiRegistry

Status reports whether the OCI and npm registries are reachable and, when the…

Status reports whether the OCI and npm registries are reachable and, when the OCI half is auth-gated, which token realm its challenge advertises — an…

GET /v1/registry/status

Addresshttps://api.hanzo.ai/v1/registry/status
MethodGET
Operationget_registry_status
AuthAuthorization: Bearer $HANZO_API_KEY

Status reports whether the OCI and npm registries are reachable and, when the OCI half is auth-gated, which token realm its challenge advertises — an honest lens for "is the registry plane up", never a fabricated ok.

Request

GET /v1/registry/status takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200registryStatusok

200 body — 6 fields.

FieldInTypeAlwaysDescription
hostbodystringHost is the OCI registry host clients push to and pull from.
ocibodybooleanOci is true when the OCI registry answered its /v2/ probe.
pkgbodybooleanPkg is true when the npm registry answered its ping.
pkgHostbodystringPkgHost is the npm registry host.
realmbodystringRealm is the token endpoint the OCI registry's challenge advertises, present only when the registry is reachable and auth-gated.
servicebodystringService is the token service name from the same challenge.

Failure carries the platform error shape — see Errors.

Examples

hanzo registry status

Registry API · All Hanzo APIs · Interactive reference

How is this guide?

On this page