Box

Execute a command in a Box

post/boxes/{boxId}/commands

Request

Base URL
https://ascii.dev/api/box/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ascii/apis/box-public-api-v1/docs/boxes/:boxId/commands/post.ts
A function with typed inputs. Its response is checked against the schema.

boxIdstring required

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

commandstring required

cwdstring

Relative working directory inside the Box work directory.

timeoutSecondsinteger

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

{
  "ok": true
}

No recorded changes to this operation across all 1 revision of this API.