api.ListNodesResponse

items object[]

The actual items

Array [

idstring

ID is the unique identifier for the node

spec object

Spec contains the desired configuration and capabilities of the node

agent_versionstring

AgentVersion is the version of the agent software running on the node

archstring

Arch is the CPU architecture (amd64, arm64)

capabilities object

Capabilities defines what this node can do

inputsstring[]

Inputs are the data input types the node can handle (e.g., "syslog", "beats")

outputsstring[]

Outputs are the data output types the node can send to (e.g., "elasticsearch", "s3")

processorsstring[]

Processors are the data processors available (e.g., "grok", "json")

runtimesstring[]

Runtimes are the execution runtimes available (e.g., "docker", "wasm")

hardware_fingerprintstring

HardwareFingerprint is a unique identifier for the hardware configuration

hostnamestring

Hostname is the network hostname of the node

labels object

Labels are key-value pairs for node selection and filtering

property name*string

namestring

Name is the human-readable name of the node

osstring

OS is the operating system (linux, windows, darwin)

status object

Status contains system-managed fields for the node

connected_sincestring

ConnectedSince is when the node connected in the current session

connection_statetypes.NodeConnectionState (string)

ConnectionState is the current connection state of the node

Possible values: [disconnected, connected, lost, deleted]

created_atstring

CreatedAt is when the node was first registered

disconnected_sincestring

DisconnectedSince is when the node last disconnected

last_edge_seq_numinteger

LastEdgeSeqNum Last seq received from edge node

last_heartbeatstring

LastHeartbeat is when the last heartbeat was received

last_orchestrator_seq_numinteger

LastOrchestratorSeqNum Last seq received from orchestrator

messagestring

Message provides additional context about the current state

resource_usage object

ResourceUsage contains the current resource usage metrics (updated with each heartbeat)

cpu_percentnumber

CPUPercent is the CPU usage percentage (0-100)

disk_capacity_bytesinteger

DiskCapacityBytes is the total disk capacity in bytes

disk_percentnumber

DiskPercent is the disk usage percentage (0-100)

disk_used_bytesinteger

DiskUsedBytes is the disk space used in bytes

memory_capacity_bytesinteger

MemoryCapacityBytes is the total available memory in bytes

memory_percentnumber

MemoryPercent is the memory usage percentage (0-100)

memory_used_bytesinteger

MemoryUsedBytes is the memory currently in use in bytes

revisioninteger

Revision is incremented on each update for optimistic concurrency control

session_idstring

SessionID uniquely identifies the current connection session

updated_atstring

UpdatedAt is when the node was last updated

]

next_tokenstring

Token for next page

api.ListNodesResponse

{
  "items": [
    {
      "id": "node-edge-us-west-01",
      "spec": {
        "agent_version": "1.2.0",
        "arch": "amd64",
        "hardware_fingerprint": "hw-abc123",
        "hostname": "edge01.example.com",
        "labels": {
          "env": "production",
          "gpu": "nvidia-t4",
          "region": "us-west",
          "role": "app-server"
        },
        "name": "edge-us-west-01",
        "os": "linux"
      },
      "status": {
        "connected_since": "2025-01-15T10:00:00Z",
        "connection_state": "connected",
        "created_at": "2025-01-10T08:00:00Z",
        "last_heartbeat": "2025-01-15T12:45:30Z",
        "message": "Healthy",
        "resource_usage": {
          "cpu_percent": 45.5,
          "disk_capacity_bytes": 536870912000,
          "disk_percent": 20,
          "disk_used_bytes": 107374182400,
          "memory_capacity_bytes": 17179869184,
          "memory_percent": 25,
          "memory_used_bytes": 4294967296
        },
        "revision": 42,
        "session_id": "sess-xyz789",
        "updated_at": "2025-01-15T12:45:30Z"
      }
    }
  ],
  "next_token": "string"
}