Returns the Zero Trust routers the caller's org owns.

GET /v1/network/routers

Network → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/network/routers`
Method	`GET`
Operation	`get_network_routers`
Auth	`Authorization: Bearer $HANZO_API_KEY`

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.

Request

GET /v1/network/routers takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	routerList	ok

200 body — 5 fields.

Field	In	Type	Always	Description
`routers`	body	routerView[]	—	Routers is one row per ZT edge-router tagged with the caller's org role.
`routers[].id`	body	string	—	ID is the ZT edge-router's id.
`routers[].name`	body	string	—	Name is the edge-router's name, falling back to its id when it has none.
`routers[].region`	body	string	—	Region comes from a "region-<slug>" role attribute and is omitted when the router carries none, so the column renders "—" rather than a guess.
`routers[].status`	body	string	—	Status is the controller's own health signal: "online" when connected, "disabled" when administratively disabled, "offline" otherwise.

Failure carries the platform error shape — see Errors.

Examples

hanzo networks routers

import { Configuration, NetworkApi } from 'hanzoai';

const api = new NetworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getNetworkRouters();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import NetworkApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = NetworkApi(client).get_network_routers()

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.NetworkAPI.GetNetworkRouters(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, network_api};

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

let result = network_api::get_network_routers(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.NetworkApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new NetworkApi(client).getNetworkRouters();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/network/routers \
  -H "Authorization: Bearer $HANZO_API_KEY"

The door reaches network through the zt tool, which names its 4 operations with its own verbs — this one among them, under a name only the door 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_mesh_services"
         }
       }
     }'

Network API · All Hanzo APIs · Interactive reference

Returns the Zero Trust routers the caller's org owns.

Request

Response

Examples

On this page