Run a command

Starts a command in a ready sandbox and answers with its run record. A command that exits nonzero, times out or cannot start is a result, not an error.

Needs the use scope.

Error

A valid request URL is required to generate request examples

200

{
  "sandbox": "<string>",
  "run": "<string>",
  "state": "running",
  "command": [
    "<string>"
  ],
  "exitCode": 123,
  "signal": "<string>",
  "timedOut": true,
  "error": "<string>",
  "stdout": "<string>",
  "stderr": "<string>",
  "stdoutTruncated": true,
  "stderrTruncated": true,
  "outputHeld": true,
  "startedAt": "2023-11-07T05:31:56Z",
  "finishedAt": "2023-11-07T05:31:56Z",
  "durationMs": 123
}

Authorizations

ticketapiKey

Authorization · string · header · required

The ticket's authorization value, sent as it is (its own scheme, not Bearer), until the ticket's expiresAt.

Path Parameters

id · string · required

The sandbox id (sbx_ and 12 hex).

Pattern: ^sbx_[0-9a-f]{12}$

Body

application/json

command · tuple · required

The program, then its arguments (no NUL characters).

Show child attributes

timeoutMs · integer

The run's time limit in ms (at most 24 h).

Required range: 1 <= x <= 86400000

idempotencyKey · string

Makes a retried run return the first one's answer; the same key with a different request is idempotency_conflict. 1 to 255 printable ASCII characters without spaces (a UUID is fine).

Pattern: ^[\x21-\x7e]{1,255}$

Response

200

application/json

The run.

sandbox · string · required

The sandbox id.

run · string · required

The run id.

Pattern: ^run_[0-9a-f]{12}$

state · enum<string> · required

running or done.

Available options: running, done

command · string[]

The command.

exitCode · integer | null

The exit code; null while running or when a signal ended it.

signal · string | null

The signal that ended it, if one did.

timedOut · boolean | null

True when it hit its time limit.

error · string | null

Why it could not start, if it could not.

stdout · string

Standard output (what is kept of it).

stderr · string

Standard error (what is kept of it).

stdoutTruncated · boolean

True once standard output passed the stored cap.

stderrTruncated · boolean

True once standard error passed the stored cap.

outputHeld · boolean | null

True when output is held back.

startedAt · string<date-time>

When it started.

finishedAt · string<date-time> | null

When it finished.

durationMs · integer | null

How long it ran, in ms.