Sign in

v1

latestOpenAPI 3.1.02026-07-22304756.7 KB
Box

Execute a command in a Box

post/boxes/{boxId}/commands

Path parameters

boxIdstring required

Public Box id returned by create/list/get box calls.

Request body

commandstring required
cwdstring

Relative working directory inside the Box work directory.

timeoutSecondsinteger

Response

Command result.

okboolean required
type'command.finished' required

Stable success envelope discriminator added by v1.

successboolean required
exitCodeinteger nullable required
signalstring nullable
stdoutstring required
stderrstring required
stdoutTruncatedboolean
stderrTruncatedboolean
timedOutboolean required
cwdstring
startedAtstring date-time
finishedAtstring date-time

Example response

{
  "ok": true
}