Hanzo
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

Addresshttps://api.hanzo.ai/v1/visor/machines/agents
MethodGET
OperationlistMachineAgents
AuthAuthorization: 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

StatusBodyMeaning
200bindingListok

200 body — 13 fields.

FieldInTypeAlwaysDescription
agentBindingsbodyagentBinding[]AgentBindings is one row per bound machine, emitted verbatim as vm reports it.
agentBindings[].agentNamebodystringAgentName is the cloud Agent (/v1/agents) this machine runs — the agent a message to the bot is actually run against.
agentBindings[].botVersionbodystringBotVersion pins the @hanzo/bot runtime version the machine runs.
agentBindings[].createdTimebodystringCreatedTime is when the binding was first made.
agentBindings[].machineIdbodystringMachineId is the bound machine as vm addresses it, owner-qualified ("<org>/<machine>").
agentBindings[].messagebodystringMessage 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[].namebodystringName 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[].orgbodystringOrg is the Hanzo tenant the binding belongs to.
agentBindings[].ownerbodystringOwner 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[].providerbodystringProvider 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[].publicIpbodystringPublicIp is the bound machine's public address as vm recorded it on the binding.
agentBindings[].statusbodystringStatus 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[].updatedTimebodystringUpdatedTime 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.


Visor API · All Hanzo APIs · Interactive reference

How is this guide?

On this page