v10

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-01384057.2 KB

cmd

Run ad-hoc command on sprouts

Execute a command on one or more targeted sprouts. The request body is a TargetedAction with a CmdRun action payload containing the command, arguments, working directory, optional runas user, environment variables, and timeout.

post/api/v1/cmd

Request body

{"stackTrail":"components:schemas:TargetedAction:properties:action","oasType":"schema","type":"unknown","description":"Action-specific payload. For `cmd.run`, this is a CmdRun object.\nFor `cook`, this is a CmdCook object. For `test.ping`, this\nis a PingPong object.\n"}

Response

Command results per sprout

{"stackTrail":"components:schemas:NATSEnvelope:properties:result","oasType":"schema","type":"unknown","description":"Response data (structure varies by endpoint — see endpoint examples)"}

errorstring

Error message (present only on failure)