Networks
The org's ZT overlay network(s)
The org's ZT overlay network(s)
| Base URL | https://api.hanzo.ai |
| Operations | 2 |
| Auth | Authorization: Bearer $HANZO_API_KEY |
networks
Returns one overlay network by id, scoped to the caller's org.
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 reques |
Returns the caller's org overlay network on the Zero Trust fabric.
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?
Mq
Package mq is Hanzo MQ, the managed message-queue product: org-scoped administration of durable JetStream queues on the platform message plane — streams, their messages, pull consumers and delivery —
Notify
Package notify is transactional email and SMS, sent through your org's own provider credential.