Run a command

Queues argv to run in the Box and returns an operation with 202 Accepted. Poll the operation until its state is done, failed or unknown; a done exec's result holds the exit code and output. See Following a request.

The caller needs an explicit grant on the Box: the owner or admin role is not enough. API keys need the write scope, and their service account needs the grant.

• The Box must be desired running. Wait until ssh.ready is true first: an exec accepted before the Box is running can fail with box is not running at the requested generation.
• The command runs as the caller's guest account, in its home directory unless cwd is set, without a shell, a TTY or stdin; use ["sh", "-c", "…"] for shell syntax. It has passwordless sudo only once the caller has an SSH key, so a service account's commands cannot rely on sudo; see Root and sudo.
• timeoutMs defaults to 60,000 (60 s), and larger values than 600,000 (10 min) are lowered to it without an error. A command that runs out of time is killed and reports timedOut: true and exit code 124.
• maxOutputBytes defaults to 65,536 (64 KiB), and larger values than 1,048,576 (1 MiB) are lowered to it. It is one budget for stdout and stderr together; the rest is discarded and truncated is true.
• A non-zero exit code or a timeout still ends done. failed comes with an error, for example when the Box stopped or the caller lost its grant before the command started. unknown means it was interrupted and may or may not have run. Neither is run again; see Operations record every request.
• Only the caller sees the result. Other members of the organization can read the operation, but its result is null for them.

With an Idempotency-Key, repeating the request with the same body returns 202 with the operation the first request created, and runs nothing. Output is returned only when the command ends. See Run commands.