Returns a single node by name.
Path parameters
The unique name of the node.
Response
Returns a Node object.
Always "caravanserai/v1".
Unique name of the node within the cluster.
Arbitrary key/value string pairs used for selection and grouping.
Non-identifying key/value metadata.
RFC 3339 timestamp set by the server on first write.
RFC 3339 timestamp updated by the server on every write.
Administrator-declared configuration of the node.
OS-level hostname of the machine.
When true, the scheduler will not assign new projects to this node.
Runtime state reported by the agent and computed by the controller manager.
High-level health summary. One of Ready, NotReady, or Draining.
RFC 3339 timestamp of the most recent heartbeat received from the agent.
Overlay-network connectivity details.
Headscale-assigned overlay IP address (e.g. "100.64.0.5").
MagicDNS FQDN for service discovery.
Connectivity mode: Direct (peer-to-peer path) or DERP (relayed).
TCP port the agent’s HTTP server listens on.
Last measured upload/download speeds.
Download speed string (e.g. "500Mbps").
Upload speed string (e.g. "100Mbps").
RFC 3339 timestamp of the most recent throughput measurement.
Raw physical resource totals reported by the agent (e.g. {"cpu": "4000m", "memory": "8Gi"}).
Capacity minus system-reserved amounts. The scheduler uses this to compute available headroom.
List of observable node conditions.
Machine-readable identifier, e.g. "Ready".
One of True, False, or Unknown.
CamelCase word summarising why the condition has this status.
Human-readable explanation.
RFC 3339 timestamp of when this condition was last sampled.
RFC 3339 timestamp of when the status last changed.
Examples
curl http://localhost:8080/api/v1/nodes/worker-01