Replace tls

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

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
acmeEmailbodystring—ACMEEmail is the ACME account email.
extraHostsbodystring[]—ExtraHosts get certificates without owning a route — at most 256.
stagingbodyboolean—Staging issues from Let's Encrypt's staging directory (untrusted certs, high rate limits).

Response

StatusBodyMeaning
200ingress.TLSConfigok
defaultproblem-detailsrefused

200 body — 3 fields.

FieldInTypeAlwaysDescription
acmeEmailbodystring—ACMEEmail is the ACME account email.
extraHostsbodystring[]—ExtraHosts get certificates without owning a route — at most 256.
stagingbodyboolean—Staging 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
import { Configuration, IngressApi } from 'hanzoai';

const api = new IngressApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putIngressTls({ acmeEmail: "<acmeEmail>", extraHosts: ["<extraHosts>"] });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import IngressApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = IngressApi(client).put_ingress_tls(acme_email="<acmeEmail>", extra_hosts=["<extraHosts>"])
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.IngressAPI.PutIngressTls(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, ingress_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = ingress_api::put_ingress_tls(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IngressApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new IngressApi(client).putIngressTls();
curl -X PUT https://api.hanzo.ai/v1/ingress/tls \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "acmeEmail": "<acmeEmail>",
       "extraHosts": [
         "<extraHosts>"
       ]
     }'

MCP reaches ingress through the ingress tool, which names its 18 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_ingress_middlewares"
         }
       }
     }'

Ingress API · All Hanzo APIs · Interactive reference

Was this page useful?