OpenapiVisor
Returns every agent↔machine binding in the caller's org — which machines are…
Returns every agent↔machine binding in the caller's org — which machines are running which cloud Agent, with vm's own reconciled status.
GET /v1/visor/machines/agents
| Address | https://api.hanzo.ai/v1/visor/machines/agents |
| Method | GET |
| Operation | listMachineAgents |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns every agent↔machine binding in the caller's org — which machines are running which cloud Agent, with vm's own reconciled status.
Request
GET /v1/visor/machines/agents takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | bindingList | ok |
200 body — 13 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
agentBindings | body | agentBinding[] | — | AgentBindings is one row per bound machine, emitted verbatim as vm reports it. |
agentBindings[].agentName | body | string | — | AgentName is the cloud Agent (/v1/agents) this machine runs — the agent a message to the bot is actually run against. |
agentBindings[].botVersion | body | string | — | BotVersion pins the @hanzo/bot runtime version the machine runs. |
agentBindings[].createdTime | body | string | — | CreatedTime is when the binding was first made. |
agentBindings[].machineId | body | string | — | MachineId is the bound machine as vm addresses it, owner-qualified ("<org>/<machine>"). |
agentBindings[].message | body | string | — | Message is vm's human-readable detail on Status ("machine provisioning; @hanzo/bot runtime not yet confirmed") — the reason behind the state, not a second… |
agentBindings[].name | body | string | — | Name is the binding's own key, which is the machine's id: a machine hosts at most one agent, so the binding is named for it. |
agentBindings[].org | body | string | — | Org is the Hanzo tenant the binding belongs to. |
agentBindings[].owner | body | string | — | Owner is the tenant vm filed the binding under, resolved from the ?owner it was called with — which is the caller's validated org and never a body field. |
agentBindings[].provider | body | string | — | Provider is the cloud the bound machine runs on, carried here so a bindings list says where each bot lives without a second read per machine. |
agentBindings[].publicIp | body | string | — | PublicIp is the bound machine's public address as vm recorded it on the binding. |
agentBindings[].status | body | string | — | Status is the binding's lifecycle in VM's OWN words — "Pending" while the machine provisions and the runtime is unconfirmed, "running" once vm has confirmed… |
agentBindings[].updatedTime | body | string | — | UpdatedTime is when vm last reconciled it — the age of Status. |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, VisorApi } from 'hanzoai';
const api = new VisorApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.listMachineAgents();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import VisorApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = VisorApi(client).list_machine_agents()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.VisorAPI.ListMachineAgents(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, visor_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = visor_api::list_machine_agents(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.VisorApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new VisorApi(client).listMachineAgents();curl https://api.hanzo.ai/v1/visor/machines/agents \
-H "Authorization: Bearer $HANZO_API_KEY"Tool visor, op listMachineAgents — 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": "visor",
"arguments": {
"op": "listMachineAgents",
"input": {}
}
}
}'How is this guide?