Hanzo
OpenapiVisor

Returns the agent binding of one of the caller org's machines, or 404 when the…

Returns the agent binding of one of the caller org's machines, or 404 when the machine runs no bot runtime.

GET /v1/visor/machines/{id}/agent

Addresshttps://api.hanzo.ai/v1/visor/machines/{id}/agent
MethodGET
OperationgetMachineAgent
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the agent binding of one of the caller org's machines, or 404 when the machine runs no bot runtime.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the machine's org-scoped NAME — the stable key Visor addresses a machine by (owner/name), not the ephemeral provider id.

Response

StatusBodyMeaning
200agentBindingok

200 body — 12 fields.

FieldInTypeAlwaysDescription
agentNamebodystringAgentName is the cloud Agent (/v1/agents) this machine runs — the agent a message to the bot is actually run against.
botVersionbodystringBotVersion pins the @hanzo/bot runtime version the machine runs.
createdTimebodystringCreatedTime is when the binding was first made.
machineIdbodystringMachineId is the bound machine as vm addresses it, owner-qualified ("<org>/<machine>").
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…
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.
orgbodystringOrg is the Hanzo tenant the binding belongs to.
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.
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.
publicIpbodystringPublicIp is the bound machine's public address as vm recorded it on the binding.
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…
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