Hanzo
OpenapiIngress

GetTLS returns the caller org's ACME intent together with the edge-wide TLS…

GetTLS returns the caller org's ACME intent together with the edge-wide TLS facts it lands in: which role this instance runs in, whether its listeners are…

GET /v1/ingress/tls

Addresshttps://api.hanzo.ai/v1/ingress/tls
MethodGET
Operationget_ingress_tls
AuthAuthorization: Bearer $HANZO_API_KEY

GetTLS returns the caller org's ACME intent together with the edge-wide TLS facts it lands in: which role this instance runs in, whether its listeners are bound, every host the ACME HostPolicy will issue a certificate for (the union across ALL orgs of TLS-marked routes and configured extraHosts, because one process holds one certificate cache), and the ACME directory and account email the process was started with.

Request

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

Response

StatusBodyMeaning
200ingressTLSok

200 body — 10 fields.

FieldInTypeAlwaysDescription
acmeDirectorybodystringACMEDirectory is the ACME endpoint in use: the staging URL, or "letsencrypt-production".
acmeEmailbodystringACMEEmail is the account email the PROCESS was started with (CLOUD_INGRESS_ACME_EMAIL), not the stored config's.
configbodyTLSConfig
config.acmeEmailbodystringACMEEmail is the ACME account email.
config.extraHostsbodystring[]ExtraHosts get certificates without owning a route — at most 256.
config.stagingbodybooleanStaging issues from Let's Encrypt's staging directory (untrusted certs, high rate limits).
edgeEnabledbodybooleanEdgeEnabled is true when the edge listeners are actually bound.
managedHostsbodystring[]ManagedHosts is every host the ACME HostPolicy will issue a certificate for — the union across ALL orgs of TLS-marked routes and configured extraHosts, because…
notebodystringNote states which fields hot-apply and which need an edge restart.
rolebodystringRole is "edge" when this instance binds the listeners, else "app".

Failure carries the platform error shape — see Errors.

Examples

hanzo ingress tls get

Ingress API · All Hanzo APIs · Interactive reference

How is this guide?

On this page