Skip to main content

List Nodes

GET 
/nodes

Returns edge nodes with filtering and pagination.

What are Nodes?​

Nodes are edge agents that execute jobs. Each node has:

  • Labels for selection (env, region, capabilities, hardware specs)
  • Resource information (CPU, memory, disk usage and capacity)
  • Connection state (connected, disconnected, initializing)
  • Capabilities (supported inputs, outputs, processors, runtimes)

Filtering​

  • states: Filter by node health (healthy, degraded, unhealthy)
  • labels: Label selector for matching nodes (e.g., "env=prod,region=us-west")

Common Patterns​

  • Find nodes for job placement: Filter by labels matching your job selector
  • Monitor node health: ?states=degraded,unhealthy
  • Find nodes by region: ?labels=region=us-west
  • List all connected nodes: (default - shows healthy nodes)
  • Recently registered: ?order_by=created_at&order=desc&limit=10
  • GET /nodes/{id}/executions - See what jobs are running on a specific node
  • GET /nodes/stats - Get aggregate statistics across all nodes

Request​

Responses​

OK