Hanzo
OpenapiNetwork

Returns one overlay network by id, scoped to the caller's org.

Returns one overlay network by id, scoped to the caller's org.

GET /v1/network/{id}

Addresshttps://api.hanzo.ai/v1/network/{id}
MethodGET
Operationget_network_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

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.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the network id from the path.

Response

StatusBodyMeaning
200networkViewok

200 body — 4 fields.

FieldInTypeAlwaysDescription
idbodystringID is the org-derived id of the overlay network — the key GET /v1/network/{id} addresses.
namebodystringName is the org the overlay belongs to.
nodesbodyintegerNodes is how many edge-routers the org has on the fabric.
statusbodystringStatus is "connected" once at least one of the org's edge-routers is online, else "provisioning" (routers exist but none has dialed home).

Failure carries the platform error shape — see Errors.

Examples

hanzo networks get <id>

Network API · All Hanzo APIs · Interactive reference

How is this guide?

On this page