Skip to main content

Get

Get detailed information about a specific agent by hostname:

$ osapi client agent get --hostname web-01

Hostname: web-01 Status: Ready
Labels: group:web.dev.us-east
OS: Ubuntu 24.04
Uptime: 6 days, 3 hours, 54 minutes
Age: 3d 4h
Last Seen: 3s ago
Load: 1.74, 1.79, 1.94 (1m, 5m, 15m)
Memory: 32.0 GB total, 19.2 GB used, 12.8 GB free

This command reads directly from the agent heartbeat registry -- no job is created. The data comes from the agent's most recent heartbeat write.

FieldDescription
HostnameAgent's configured or OS hostname
StatusReady if present in registry
LabelsKey-value labels from agent config
OSDistribution and version
UptimeSystem uptime reported by the agent
AgeTime since the agent process started
Last SeenTime since the last heartbeat refresh
Load1-, 5-, and 15-minute load averages
MemoryTotal, used, and free RAM
agent get vs. node status

agent get shows lightweight data from the heartbeat registry (instant, no job). node status runs a full system inspection via the job system (includes disk usage, deeper metrics).

Flags

FlagDescriptionRequired
--hostnameHostname of the agent to retrieveYes