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
| Address | https://api.hanzo.ai/v1/ingress/tls |
| Method | GET |
| Operation | get_ingress_tls |
| Auth | Authorization: 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
| Status | Body | Meaning |
|---|---|---|
200 | ingressTLS | ok |
200 body — 10 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
acmeDirectory | body | string | — | ACMEDirectory is the ACME endpoint in use: the staging URL, or "letsencrypt-production". |
acmeEmail | body | string | — | ACMEEmail is the account email the PROCESS was started with (CLOUD_INGRESS_ACME_EMAIL), not the stored config's. |
config | body | TLSConfig | — | |
config.acmeEmail | body | string | — | ACMEEmail is the ACME account email. |
config.extraHosts | body | string[] | — | ExtraHosts get certificates without owning a route — at most 256. |
config.staging | body | boolean | — | Staging issues from Let's Encrypt's staging directory (untrusted certs, high rate limits). |
edgeEnabled | body | boolean | — | EdgeEnabled is true when the edge listeners are actually bound. |
managedHosts | body | string[] | — | 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… |
note | body | string | — | Note states which fields hot-apply and which need an edge restart. |
role | body | string | — | Role is "edge" when this instance binds the listeners, else "app". |
Failure carries the platform error shape — see Errors.
Examples
hanzo ingress tls getimport { Configuration, IngressApi } from 'hanzoai';
const api = new IngressApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getIngressTls();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).get_ingress_tls()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IngressAPI.GetIngressTls(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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::get_ingress_tls(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IngressApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new IngressApi(client).getIngressTls();curl https://api.hanzo.ai/v1/ingress/tls \
-H "Authorization: Bearer $HANZO_API_KEY"Tool ingress, op get_ingress_tls — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "ingress",
"arguments": {
"op": "get_ingress_tls",
"input": {}
}
}
}'How is this guide?