Hanzo
OpenapiIngress

Status reports the ingress edge's live posture: the role this instance runs in…

Status reports the ingress edge's live posture: the role this instance runs in (app or edge), whether its listeners are bound and on which addresses, the…

GET /v1/ingress/status

Addresshttps://api.hanzo.ai/v1/ingress/status
MethodGET
Operationget_ingress_status
AuthAuthorization: Bearer $HANZO_API_KEY

Status reports the ingress edge's live posture: the role this instance runs in (app or edge), whether its listeners are bound and on which addresses, the ACME posture (staging flag and certificate cache directory), how many hosts the compiled route table currently serves, and how many the ACME HostPolicy will issue a certificate for.

Request

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

Response

StatusBodyMeaning
200ingressStatusok

200 body — 9 fields.

FieldInTypeAlwaysDescription
acmeCacheDirbodystringACMECacheDir is where autocert persists accounts and certificates.
acmeStagingbodybooleanACMEStaging is true when certificates are issued from Let's Encrypt staging.
edgeEnabledbodybooleanEdgeEnabled is true when the edge listeners are actually bound.
httpAddrbodystringHTTPAddr is the address the ACME HTTP-01 + HTTP router listens on.
httpsAddrbodystringHTTPSAddr is the address the SNI TLS terminator listens on.
liveHostsbodyintegerLiveHosts is how many hosts the compiled table routes.
proxybodystringProxy names the reverse-proxy implementation behind every route.
rolebodystringRole is "edge" when CLOUD_INGRESS_EDGE_ENABLED is set, else "app".
tlsHostsbodyintegerTLSHosts is how many hosts the ACME HostPolicy will issue a certificate for.

Failure carries the platform error shape — see Errors.

Examples

hanzo ingress status

Ingress API · All Hanzo APIs · Interactive reference

How is this guide?

On this page