Networks
Package zt mounts the Hanzo Cloud NETWORKING surface: the tenant's Hanzo Zero Trust footprint — overlay networks, their routers and mesh services — served as clean, org-scoped REST off the unified…
Package zt mounts the Hanzo Cloud NETWORKING surface: the tenant's Hanzo Zero Trust footprint — overlay networks, their routers and mesh services — served as clean, org-scoped REST off the unified cloud binary and fronting the Hanzo Zero Trust controller (hanzoai/zt, an OpenZiti-based fabric).
| Base URL | https://api.hanzo.ai |
| Operations | 3 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
networks
GET /v1/networks/{id}
Returns one overlay network by id, scoped to the caller's org.
The org has exactly one overlay network and its id is derived from the org, so any other id — another tenant's, or one that does not exist — is 404 rather than a peek across the tenant boundary. An org whose network exists but has no edge-routers is 404 too, for the same reason the list is empty: there is no overlay until something is on it.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the network id from the path. The URL is the addressing authority, so it binds from there whatever else the… |
GET /v1/networks/routers
Returns the Zero Trust routers the caller's org owns.
One row per real ZT edge-router tagged with the org's "org-<org>" role attribute, carrying the controller's own health signal: "online" when connected, "disabled" when administratively disabled, "offline" otherwise. region is filled only from a "region-<slug>" role attribute and omitted when the router carries none, so the column renders "—" rather than a guess.
The read degrades rather than erroring: a deployment with no ZT credential, and a controller that cannot be reached, both answer 200 with an empty list.
GET /v1/networks
Returns the caller's org overlay network on the Zero Trust fabric.
The org has at most ONE overlay, projected from the edge-routers tagged with its "org-<org>" role attribute: nodes is the real router count and status is "connected" once at least one router has dialed home, "provisioning" while none has. An org with no routers gets an empty list, never a fabricated network.
The read degrades rather than erroring: a deployment with no ZT credential, and a controller that cannot be reached, both answer 200 with an empty list so the console's Networks page renders a clean empty state instead of an error.
How is this guide?