Hanzo
OpenapiProjects

health reports whether a publish reaches readers, rather than whether it was…

health reports whether a publish reaches readers, rather than whether it was accepted.

GET /v1/projects/edge

Addresshttps://api.hanzo.ai/v1/projects/edge
MethodGET
Operationget_projects_edge
AuthAuthorization: Bearer $HANZO_API_KEY

health reports whether a publish reaches readers, rather than whether it was accepted. Those are different questions and only the second one was ever visible.

It asks the edge and nothing else. There is no live call to the provider here: Configured is a local fact, it is the fact that was missing, and a health check that spends a third-party API call is one an operator learns not to run.

Request

GET /v1/projects/edge takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200edgeStateok
503edgeStateservice unavailable

200 body — 8 fields.

FieldInTypeAlwaysDescription
configuredbodybooleanConfigured is whether the edge holds credentials to act at all.
errorbodystringError is the blocker, so an operator reads it instead of guessing at it.
freshnessbodystringFreshness says, in one phrase, how long after a publish a reader sees it.
policybodyobjectPolicy is the Cache-Control this edge serves each class of object with.
policy.*bodystring
providerbodystringProvider is the CDN behind this edge, or "none".
reachbodystring[]Reach is the apexes a publish is invalidated on.
statusbodystringStatus is "ok" when a publish reaches readers immediately, else "degraded".

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Projects API · All Hanzo APIs · Interactive reference

How is this guide?

On this page