Hanzo
OpenapiIngress

PutTLS replaces the caller org's ACME intent and hot-applies what can be…

PutTLS replaces the caller org's ACME intent and hot-applies what can be hot-applied.

PUT /v1/ingress/tls

Addresshttps://api.hanzo.ai/v1/ingress/tls
MethodPUT
Operationput_ingress_tls
AuthAuthorization: Bearer $HANZO_API_KEY

PutTLS replaces the caller org's ACME intent and hot-applies what can be hot-applied. extraHosts are normalized and validated, then feed the ACME HostPolicy on the reload this op performs, alongside the per-route tls flags. acmeEmail and staging bind an ACME account for the lifetime of an edge process, so they only take effect when the edge (re)starts — the returned note says so.

Request

3 fields, body application/json (required).

FieldInTypeRequiredDescription
acmeEmailbodystringACMEEmail is the ACME account email.
extraHostsbodystring[]ExtraHosts get certificates without owning a route — at most 256.
stagingbodybooleanStaging issues from Let's Encrypt's staging directory (untrusted certs, high rate limits).

Response

StatusBodyMeaning
200TLSConfigok

200 body — 3 fields.

FieldInTypeAlwaysDescription
acmeEmailbodystringACMEEmail is the ACME account email.
extraHostsbodystring[]ExtraHosts get certificates without owning a route — at most 256.
stagingbodybooleanStaging issues from Let's Encrypt's staging directory (untrusted certs, high rate limits).

Failure carries the platform error shape — see Errors.

Examples

hanzo ingress tls replace

Ingress API · All Hanzo APIs · Interactive reference

How is this guide?

On this page