Skip to main content

​
List Nodes

​
config
string
required
Configuration identifier
​
cluster
string
required
Cluster identifier
curl -X GET "http://localhost:9090/api/v1/nodes?config=default&cluster=local" \
  -H "Accept: text/event-stream"
​
uid
string
Unique identifier for the node
​
name
string
Node name
​
resourceVersion
string
Resource version
​
roles
array
Node roles (e.g., control-plane, worker)
​
age
string
Creation timestamp
​
spec
object
Node specification
​
podCIDR
string
Pod CIDR for the node
​
podCIDRs
array
List of pod CIDRs
​
providerID
string
Cloud provider identifier
​
status
object
Node status
​
conditionStatus
string
Node condition status (True, False, Unknown)
​
addresses
object
Node addresses
​
internalIP
string
Internal IP address
​
nodeInfo
object
Node system information
​
machineID
string
Machine ID
​
systemUUID
string
System UUID
​
kernelVersion
string
Kernel version
​
osImage
string
Operating system image
​
containerRuntimeVersion
string
Container runtime version
​
kubeletVersion
string
Kubelet version
​
kubeProxyVersion
string
Kube-proxy version
​
operatingSystem
string
Operating system
​
architecture
string
Architecture (e.g., amd64, arm64)

​
Get Node Details

​
name
string
required
Node name
​
config
string
required
Configuration identifier
​
cluster
string
required
Cluster identifier
curl -X GET "http://localhost:9090/api/v1/nodes/node-1?config=default&cluster=local" \
  -H "Accept: text/event-stream"
Returns detailed information about a specific node including its specification, status, and system information.

​
Get Node YAML

​
name
string
required
Node name
​
config
string
required
Configuration identifier
​
cluster
string
required
Cluster identifier
curl -X GET "http://localhost:9090/api/v1/nodes/node-1/yaml?config=default&cluster=local" \
  -H "Accept: text/event-stream"
Returns the complete YAML representation of the node.

​
Get Node Events

​
name
string
required
Node name
​
config
string
required
Configuration identifier
​
cluster
string
required
Cluster identifier
curl -X GET "http://localhost:9090/api/v1/nodes/node-1/events?config=default&cluster=local" \
  -H "Accept: text/event-stream"
Returns events associated with the node.

​
Get Node Pods

​
name
string
required
Node name
​
config
string
required
Configuration identifier
​
cluster
string
required
Cluster identifier
curl -X GET "http://localhost:9090/api/v1/nodes/node-1/pods?config=default&cluster=local" \
  -H "Accept: text/event-stream"
Returns all pods running on the specified node. This endpoint streams pod information for real-time monitoring of pods scheduled on the node.

Build docs developers (and LLMs) love

Get started for freeTalk to us