Run a command in the sandbox and return its output.

curl --request POST \
  --url https://api.instabox.sh/v1/machines/{id}/exec \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cmd": "<string>",
  "argv": [
    "<string>"
  ],
  "cwd": "<string>",
  "envs": {},
  "secretEnvs": {},
  "timeoutSeconds": 300,
  "stdin": "<string>",
  "noHistory": true,
  "historyCommand": "<string>"
}
'

import requests

url = "https://api.instabox.sh/v1/machines/{id}/exec"

payload = {
    "cmd": "<string>",
    "argv": ["<string>"],
    "cwd": "<string>",
    "envs": {},
    "secretEnvs": {},
    "timeoutSeconds": 300,
    "stdin": "<string>",
    "noHistory": True,
    "historyCommand": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cmd: '<string>',
    argv: ['<string>'],
    cwd: '<string>',
    envs: {},
    secretEnvs: {},
    timeoutSeconds: 300,
    stdin: '<string>',
    noHistory: true,
    historyCommand: '<string>'
  })
};

fetch('https://api.instabox.sh/v1/machines/{id}/exec', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.instabox.sh/v1/machines/{id}/exec",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cmd' => '<string>',
    'argv' => [
        '<string>'
    ],
    'cwd' => '<string>',
    'envs' => [
        
    ],
    'secretEnvs' => [
        
    ],
    'timeoutSeconds' => 300,
    'stdin' => '<string>',
    'noHistory' => true,
    'historyCommand' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.instabox.sh/v1/machines/{id}/exec"

	payload := strings.NewReader("{\n  \"cmd\": \"<string>\",\n  \"argv\": [\n    \"<string>\"\n  ],\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"secretEnvs\": {},\n  \"timeoutSeconds\": 300,\n  \"stdin\": \"<string>\",\n  \"noHistory\": true,\n  \"historyCommand\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.instabox.sh/v1/machines/{id}/exec")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cmd\": \"<string>\",\n  \"argv\": [\n    \"<string>\"\n  ],\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"secretEnvs\": {},\n  \"timeoutSeconds\": 300,\n  \"stdin\": \"<string>\",\n  \"noHistory\": true,\n  \"historyCommand\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.instabox.sh/v1/machines/{id}/exec")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cmd\": \"<string>\",\n  \"argv\": [\n    \"<string>\"\n  ],\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"secretEnvs\": {},\n  \"timeoutSeconds\": 300,\n  \"stdin\": \"<string>\",\n  \"noHistory\": true,\n  \"historyCommand\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "stdout": "<string>",
  "stderr": "<string>",
  "exitCode": 123,
  "timedOut": true,
  "truncated": true,
  "signal": "<string>",
  "diskWarning": {
    "mount": "<string>",
    "usedPct": 123,
    "level": "ok",
    "message": "<string>",
    "noSpace": true
  },
  "invalidUtf8": true,
  "oomKilled": true,
  "oomKill": {
    "at": "2023-11-07T05:31:56Z",
    "pid": 123,
    "process": "<string>",
    "rssBytes": 123,
    "anonRssBytes": 123,
    "cgroup": true,
    "uid": 123
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

Commands and files

Run a command in the sandbox and return its output.

Runs cmd with bash -lc as the sandbox’s login user (dev, HOME /data/home, the user SSH sessions get), after exporting envs and changing to cwd (default HOME, even if the profile changes directory; a cwd that does not exist makes the command fail with exit code 1). stdin is fed to the command, then EOF: UTF-8 text of at most 1 MiB (1048576 bytes, not characters); bytes that are not UTF-8 become U+FFFD, so base64-encode binary input or write it with PUT /v1/machines/{id}/files first (see ExecRequest.stdin).

Instead of cmd, send argv (a program and its arguments) to run it with no shell: {"argv": ["printf", "%s|", "a b", "$X"]} prints a b|$X|. The login profile, envs and cwd apply the same way; only the parsing of the command differs. Set exactly one of cmd and argv.

The request blocks until the command exits or timeoutSeconds passes. On timeout the command’s process group is killed (SIGKILL) and the result has timedOut: true and exitCode: 124 (also when the sandbox did not start the command in time). A command killed by a signal has signal set and exitCode 128+N for standard signal N, otherwise 255. A non-zero exit code is a 200 result, not an error. The request returns when the command exits, even if a process it started in the background keeps its stdout or stderr open: that process keeps running, output it writes later than about a second after the exit is not returned, and its later writes to that output fail with a broken pipe, so redirect a server’s stdout and stderr to a file (nohup server >log 2>&1 &). stdout and stderr keep their first 1 MiB each (truncated: true when either was cut); invalid UTF-8 is replaced with U+FFFD (invalidUtf8: true), so binary output is not byte-exact: read files with GET /v1/machines/{id}/files/content.

The sandbox must be running (409 machine_not_running). At most 32 requests run at once per user on the free plan, per workspace for a workspace’s API keys (Pro 64; Builder, Team and Enterprise 256), across all your sandboxes. Commands, file reads, desktop, port-forward and Secret refresh calls share this limit. A background command counts only while it starts. More get a retryable 429 quota_exceeded (server config limits.maxExecsPerUser, plans.<tier>.maxExecs and limits.maxExecsPerOrg, not reported by GET /v1/usage). If the sandbox cannot be reached, 503 host_unavailable; when the connection is lost after the command started it is not retryable, since the command may have run (it is killed, not left running). An API server that restarts mid-command kills it and answers a retryable 503 host_unavailable (“the API server restarted before the command finished”). Not idempotent: no Idempotency-Key, and a retry runs the command again. API keys: needs one of the scopes machines:write, machines:exec (legacy).

Streaming: send Accept: text/event-stream to get the output as the command writes it, as server-sent events: a stdout or stderr event (data: ExecOutput) for each chunk, a : ping comment every 15 s while the command is quiet, then one exit event (data: the ExecResult, with empty stdout and stderr and never truncated: streamed output is not capped) or error event (data: an ErrorBody, e.g. host_unavailable when the connection to the sandbox was lost). Errors found before the command starts (400, 404, 409, 429, a 503 dial failure) are plain JSON responses. Closing the stream kills the command. Timeouts are the same as without streaming; for a command longer than 10 minutes start it in the background (instabox exec --background) and follow its log.

POST

machines

{id}

exec

Run a command in the sandbox and return its output.

curl --request POST \
  --url https://api.instabox.sh/v1/machines/{id}/exec \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cmd": "<string>",
  "argv": [
    "<string>"
  ],
  "cwd": "<string>",
  "envs": {},
  "secretEnvs": {},
  "timeoutSeconds": 300,
  "stdin": "<string>",
  "noHistory": true,
  "historyCommand": "<string>"
}
'

import requests

url = "https://api.instabox.sh/v1/machines/{id}/exec"

payload = {
    "cmd": "<string>",
    "argv": ["<string>"],
    "cwd": "<string>",
    "envs": {},
    "secretEnvs": {},
    "timeoutSeconds": 300,
    "stdin": "<string>",
    "noHistory": True,
    "historyCommand": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cmd: '<string>',
    argv: ['<string>'],
    cwd: '<string>',
    envs: {},
    secretEnvs: {},
    timeoutSeconds: 300,
    stdin: '<string>',
    noHistory: true,
    historyCommand: '<string>'
  })
};

fetch('https://api.instabox.sh/v1/machines/{id}/exec', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.instabox.sh/v1/machines/{id}/exec",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cmd' => '<string>',
    'argv' => [
        '<string>'
    ],
    'cwd' => '<string>',
    'envs' => [
        
    ],
    'secretEnvs' => [
        
    ],
    'timeoutSeconds' => 300,
    'stdin' => '<string>',
    'noHistory' => true,
    'historyCommand' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.instabox.sh/v1/machines/{id}/exec"

	payload := strings.NewReader("{\n  \"cmd\": \"<string>\",\n  \"argv\": [\n    \"<string>\"\n  ],\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"secretEnvs\": {},\n  \"timeoutSeconds\": 300,\n  \"stdin\": \"<string>\",\n  \"noHistory\": true,\n  \"historyCommand\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.instabox.sh/v1/machines/{id}/exec")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cmd\": \"<string>\",\n  \"argv\": [\n    \"<string>\"\n  ],\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"secretEnvs\": {},\n  \"timeoutSeconds\": 300,\n  \"stdin\": \"<string>\",\n  \"noHistory\": true,\n  \"historyCommand\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.instabox.sh/v1/machines/{id}/exec")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cmd\": \"<string>\",\n  \"argv\": [\n    \"<string>\"\n  ],\n  \"cwd\": \"<string>\",\n  \"envs\": {},\n  \"secretEnvs\": {},\n  \"timeoutSeconds\": 300,\n  \"stdin\": \"<string>\",\n  \"noHistory\": true,\n  \"historyCommand\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "stdout": "<string>",
  "stderr": "<string>",
  "exitCode": 123,
  "timedOut": true,
  "truncated": true,
  "signal": "<string>",
  "diskWarning": {
    "mount": "<string>",
    "usedPct": 123,
    "level": "ok",
    "message": "<string>",
    "noSpace": true
  },
  "invalidUtf8": true,
  "oomKilled": true,
  "oomKill": {
    "at": "2023-11-07T05:31:56Z",
    "pid": 123,
    "process": "<string>",
    "rssBytes": 123,
    "anonRssBytes": 123,
    "cgroup": true,
    "uid": 123
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "operationId": "<string>",
    "reason": "missing_key",
    "hint": "<string>",
    "docs": "<string>",
    "docs_url": "<string>",
    "requiredScopes": [
      "<string>"
    ],
    "retryAfterSeconds": 2,
    "at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Opaque instabox access token (1 hour). Refresh with /v1/auth/refresh (refresh token valid 30 days, rotates on use).

Path Parameters

string

required

Sandbox ID (m_ + 26 lowercase base32 characters) or the sandbox's name (unique among your sandboxes; names never contain _, so the two never collide). Older servers take only the ID and answer 404 for a name.

Pattern: ^(m_[a-z2-7]{26}|[a-z0-9][a-z0-9-]{0,62})$

Body

application/json

Option 1
Option 2

Set exactly one of cmd (a shell string) and argv (a program and its arguments, run without a shell); both, neither or an empty argv is 400 bad_request. An empty cmd counts as no cmd, so {"cmd": "", "argv": [...]} runs the argv.

cmd

string

required

Shell command, run with bash -lc. At most 64 KiB, no NUL bytes. Set this or argv; an empty cmd is no cmd.

Required string length: 1 - 65536

argv

string[]

The program and its arguments, run with no shell: each element reaches the program exactly as sent (no expansion of $, * or ~, no word splitting, quotes or redirections; "" is an empty argument). argv[0] must not be empty and is looked up on the login profile's PATH; the login profile, envs and cwd apply as for cmd. A program that is not found exits 127, one that cannot run 126. At most 64 KiB counting each element's length plus one, no NUL bytes. The command sent to the sandbox (envs, cwd and argv, quoted for the shell: about 9 bytes per element plus its text) must also stay under 128 KiB, so many short elements can be 400 bad_request below the 64 KiB cap; send bulk data on stdin. Set this or cmd.

Minimum array length: 1

cwd

string

Working directory (default HOME, /data/home).

Maximum string length: 4096

envs

object

Environment variables exported before the command (after the login profile). Names match ^[A-Za-z_][A-Za-z0-9_]*$.

Show child attributes

secretEnvs

object

Direct (delivery env) Secrets of the sandbox's org exported for this command only: variable name -> Secret name. Resolved at exec time, never stored or written into the sandbox; each use is audited by name. A name may not also be in envs; reserved variables are refused. A proxy or missing Secret is 400. Only where GET /v1/me has directSecretRefs; elsewhere 400 (a control host from before secretEnvs would run the command without them).

Show child attributes

timeoutSeconds

integer

Default 60, max 600.

Required range: 1 <= x <= 600

stdin

string

Text fed to the command, then EOF. It is a JSON string, so the command reads its UTF-8 bytes: NUL, CR and LF arrive unchanged (escaped as \u0000, \r, \n). At most 1 MiB (1048576 bytes) of UTF-8, counted in bytes, not characters (é is 2): more is 400 bad_request stdin is longer than 1048576 bytes. The schema sets no maxLength here, because maxLength counts characters. JSON cannot carry bytes that are not UTF-8; any in the request body reach the command as U+FFFD (ef bf bd), with no error. For binary input, send it base64-encoded and decode it in the command (base64 -d | ...; up to 768 KiB of binary fits), or write the file first with PUT /v1/machines/{id}/files and redirect it in (cmd < file). The CLI's exec --stdin does that upload itself for input past 1 MiB or not UTF-8, up to 5 GiB.

noHistory

boolean

Leave the command out of the sandbox's history (GET /v1/machines/{id}/history): for a client's own housekeeping commands, such as the CLI's job polls. Does not go with historyCommand.

historyCommand

string

How the command appears in the sandbox's history instead of cmd or argv, for a wrapper that runs something else (the CLI's exec --background). Cut at 4096 bytes like them; no NUL bytes.

Response

The command ran (whatever its exit code).

stdout

string

required

First 1 MiB of standard output.

stderr

string

required

First 1 MiB of standard error.

exitCode

integer

required

Exit status; 128+N if killed by standard signal N, otherwise 255 with signal set; 124 if timed out.

timedOut

boolean

required

The command ran past timeoutSeconds and was killed.

truncated

boolean

required

stdout or stderr was longer than 1 MiB and was cut.

signal

string

The signal that killed the command, as the sandbox named it (absent otherwise).

diskWarning

object

Set when the command failed with No space left on device (read again right after it), or a filesystem was at least 90% full when last read (read in the background after an exec or metrics call, at most once a minute).

Show child attributes

invalidUtf8

boolean

stdout or stderr had bytes that are not UTF-8 (binary output), replaced with U+FFFD, so the output is not what the command wrote. Absent when false; also set on a streamed exec's exit event.

oomKilled

boolean

The command exited non-zero and the sandbox's kernel OOM killer killed one of its own processes (the command or a child: its SSH session's cgroup; never another command's process, and each kill is reported once). oomKill says which, when the sandbox named it. Checked only for exit code 137, a signal, or stderr saying a process was killed. False when none was seen, the exec's session scope could not be read, or the sandbox's host or guest agent cannot report kills; a kill whose kernel log record was lost is still true when the session scope's oom_kill count shows it (oomKill absent). Absent from older servers. Also set on a streamed exec's exit event.

oomKill

object

The OOM kill behind oomKilled (the newest, when several).

Show child attributes