Skip to main content

Nodes

Nodes are the machines that run agents. Read their status, health and metrics, group them into node groups that projects run on, manage their GitHub Actions runner pools, configure cloud connections, hosts and virtual nodes, choose a node's NodeLinks, and send commands to nodes and read the command log.

๐Ÿ“„๏ธCreate cloud connection

Creates a cloud connection over one credential of the chosen `provider` (`aws` when omitted) in one region; a cloud not on the org's plan returns 403. A blank `image` (or `ami_id`) takes the newest Ubuntu LTS image at every launch, and blank `network` fields are resolved now and returned resolved (on AWS the default VPC and a `jaah-node` group). Requires the Org Owner or Org Admin role, and returns 502 with the cloud's own message when it refuses the lookup.

๐Ÿ“„๏ธSend a command to a node

Runs a command, such as a worktree, stack or agent account operation, on a node the caller may change, and waits for its reply. Worktree and stack commands need worktree edit or system create permission, and the rest system create permission, except that a member who may add agent accounts may run the add-account steps for their own account; commands reserved to Jaah return 403. Returns 201 with the command's status and result, 503 when the node is not connected, and 504 when it does not answer in time.