Sign in
Agent Tunnels

Get list of agent tunnels

Retrieve all currently connected agent tunnels, both bound to nodes and unbound (waiting for bind). Requires MANAGE_AGENT_TUNNELS system access right.

get/v1/agent-tunnels

Response

List of agent tunnels.

idinteger

Tunnel ID (valid only while tunnel is connected)

guidstring uuid
nodeIdinteger

ID of the node tunnel is bound to, 0 if unbound

boundboolean
inboundboolean

True for tunnels initiated by agent, false for outbound tunnels initiated by server

zoneUINinteger
systemNamestring nullable
systemInformationstring nullable
hostnamestring
platformNamestring nullable
agentVersionstring nullable
agentBuildTagstring nullable
agentIdstring uuid
hardwareIdstring nullable

Hardware ID as hex string, null if agent did not report one

serialNumberstring nullable
activeChannelCountinteger
userAgentInstalledboolean
agentProxyboolean
snmpProxyboolean
snmpTrapProxyboolean
syslogProxyboolean
certificateIssuerstring nullable
certificateSubjectstring nullable
certificateExpirationTimestring date-time nullable
externallyProvisionedCertificateboolean
connectionTimestring date-time nullable

Changes

Changed in 1 of the 128 revisions of this API.1