Reference

API reference

Every upstream API call, with its request and response fields. The reference is generated from the platform's API contract, so it always matches what the service accepts.

Basics#

The API speaks ConnectRPC over HTTPS with JSON bodies. Every call is a POST to https://api.upstream.build/upstream.platform.v1.Platform/<Method>, authenticated with your API key as a bearer token.

bash

$ curl https://api.upstream.build/upstream.platform.v1.Platform/CreateSandbox \
    -H "Authorization: Bearer $UPSTREAM_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"template": "python"}'

Field names are lowerCamelCase in JSON: sandbox_id is sent as sandboxId.
Bytes fields, such as file contents and command output, are base64-encoded.
64-bit integers are encoded as strings.
Sandbox tokens. CreateSandbox, ForkSandbox and the other calls that create a sandbox return an authToken scoped to it. The SDK sends it with every call on that sandbox in the X-Sandbox-Token header.

Errors#

Errors follow the Connect protocol: a non-200 status with a JSON body carrying a code and a human-readable message.

json

{ "code": "not_found", "message": "sandbox sb_7f3a2c not found" }

A missing or invalid key returns 401 or 403, and exceeding a rate limit or quota returns 429.

Sandboxes#

CreateSandbox#

Create a sandbox from a template. Returns its ID and the token for requests to it.

POST/upstream.platform.v1.Platform/CreateSandbox

Request

Field	Type	Description
`template`	string	Template name.
`env`	map<string, string>	Environment variables.
`cwd`	string	Working directory inside the sandbox
`metadata`	map<string, string>	Your own key-value labels.
`volumeMounts`	VolumeMountSpec[]	Optional persistent volume mounts
`onTimeout`	string	"destroy" (default) or "pause".

Response

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`status`	string	Current status.
`authToken`	string	Token for requests to this sandbox. The SDK sends it for you.

example request

{
  "template": "python",
  "env": {
    "DEBUG": "1"
  },
  "cwd": "/workspace",
  "metadata": {
    "team": "evals"
  },
  "volumeMounts": [
    {
      "volumeId": "vol_3c1d8e",
      "mountPath": "/data",
      "readOnly": false
    }
  ],
  "onTimeout": "pause"
}

GetSandbox#

Get a sandbox's status, template and resources, and its parent if it is a fork.

POST/upstream.platform.v1.Platform/GetSandbox

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.

Response

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`status`	string	Current status.
`template`	string	Template name.
`vcpu`	integer	Virtual CPUs.
`memoryMib`	integer	Memory in MiB.
`createdAt`	string	RFC 3339 timestamp.
`parentSandboxId`	string	Parent sandbox, if this sandbox is a fork. Empty otherwise.
`forkLatencyMs`	integer	How long the fork took, in milliseconds. Zero for sandboxes that are not forks.

example request

{
  "sandboxId": "sb_7f3a2c"
}

ListSandboxes#

List your sandboxes.

POST/upstream.platform.v1.Platform/ListSandboxes

Request

No fields.

Response

Field	Type	Description
`sandboxes`	GetSandboxResponse[]

example request

{}

DeleteSandbox#

Destroy a sandbox and discard its private state.

POST/upstream.platform.v1.Platform/DeleteSandbox

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.

Response

No fields.

example request

{
  "sandboxId": "sb_7f3a2c"
}

RunSandbox#

Create a sandbox and run commands in it, in one round trip.

POST/upstream.platform.v1.Platform/RunSandbox

Request

Field	Type	Description
`template`	string	Template name.
`env`	map<string, string>	Environment variables.
`cwd`	string
`commands`	BatchExecCommand[]	Commands to execute immediately after creation.

Response

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`status`	string	Current status.
`authToken`	string	Token for requests to this sandbox. The SDK sends it for you.
`execResults`	ExecResponse[]	Results from the immediate commands.

example request

{
  "template": "python",
  "env": {
    "DEBUG": "1"
  },
  "cwd": "/workspace",
  "commands": [
    {
      "command": [
        "python3",
        "-c",
        "print('hello')"
      ],
      "workingDir": "/workspace",
      "env": {
        "DEBUG": "1"
      }
    }
  ]
}

KeepAlive#

Extend a sandbox's lifetime.

POST/upstream.platform.v1.Platform/KeepAlive

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`timeoutSeconds`	integer (string)

Response

No fields.

example request

{
  "sandboxId": "sb_7f3a2c",
  "timeoutSeconds": 1800
}

SetTimeout#

Set how long a sandbox may live before its timeout action runs.

POST/upstream.platform.v1.Platform/SetTimeout

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`timeoutSeconds`	integer (string)

Response

No fields.

example request

{
  "sandboxId": "sb_7f3a2c",
  "timeoutSeconds": 1800
}

PauseSandbox#

Suspend a sandbox's VM in place.

POST/upstream.platform.v1.Platform/PauseSandbox

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.

Response

No fields.

example request

{
  "sandboxId": "sb_7f3a2c"
}

ResumeSandbox#

Resume a paused sandbox.

POST/upstream.platform.v1.Platform/ResumeSandbox

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.

Response

No fields.

example request

{
  "sandboxId": "sb_7f3a2c"
}

Forks, clones and snapshots#

ForkSandbox#

Fork a running sandbox. The child resumes with the parent's memory, files and processes, and shares the parent's pages until it writes. The parent's template must be forkable.

POST/upstream.platform.v1.Platform/ForkSandbox

Request

Field	Type	Description
`parentSandboxId`	string	The sandbox to fork.
`workloadId`	string	Optional label for the fork.

Response

Field	Type	Description
`sandboxId`	string	The new fork's ID.
`sourceSandboxId`	string	The parent sandbox.
`status`	string	Current status.
`authToken`	string	Token for requests to this sandbox. The SDK sends it for you.
`forkLatencyMs`	integer	How long the fork took, in milliseconds. Zero for sandboxes that are not forks.

example request

{
  "parentSandboxId": "sb_7f3a2c",
  "workloadId": "…"
}

CloneSandbox#

Copy a sandbox's state into a new, independent sandbox.

POST/upstream.platform.v1.Platform/CloneSandbox

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`label`	string	Human-readable label.

Response

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`sourceSandboxId`	string
`status`	string	Current status.
`authToken`	string	Token for requests to this sandbox. The SDK sends it for you.

example request

{
  "sandboxId": "sb_7f3a2c",
  "label": "after-install"
}

CreateSnapshot#

Save a sandbox's full state under a label.

POST/upstream.platform.v1.Platform/CreateSnapshot

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`label`	string	Human-readable label.

Response

Field	Type	Description
`snapshot`	SnapshotInfo

example request

{
  "sandboxId": "sb_7f3a2c",
  "label": "after-install"
}

ListSnapshots#

List snapshots, optionally for one sandbox.

POST/upstream.platform.v1.Platform/ListSnapshots

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.

Response

Field	Type	Description
`snapshots`	SnapshotInfo[]

example request

{
  "sandboxId": "sb_7f3a2c"
}

RestoreSnapshot#

Start a new sandbox from a snapshot.

POST/upstream.platform.v1.Platform/RestoreSnapshot

Request

Field	Type	Description
`snapshotId`	string	Snapshot ID.

Response

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`status`	string	Current status.
`authToken`	string	Token for requests to this sandbox. The SDK sends it for you.

example request

{
  "snapshotId": "snap_91be04"
}

DeleteSnapshot#

Delete a snapshot.

POST/upstream.platform.v1.Platform/DeleteSnapshot

Request

Field	Type	Description
`snapshotId`	string	Snapshot ID.

Response

No fields.

example request

{
  "snapshotId": "snap_91be04"
}

Execution#

Exec#

Run a command and wait for it to finish.

POST/upstream.platform.v1.Platform/Exec

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`command`	string[]	Program and arguments.
`workingDir`	string	Directory to run in. Defaults to the sandbox's working directory.
`env`	map<string, string>	Environment variables.

Response

Field	Type	Description
`exitCode`	integer	Exit status of the command.
`stdout`	bytes (base64)	Standard output.
`stderr`	bytes (base64)	Standard error.
`durationMs`	integer (string)	Run time in milliseconds.

example request

{
  "sandboxId": "sb_7f3a2c",
  "command": [
    "python3",
    "-c",
    "print('hello')"
  ],
  "workingDir": "/workspace",
  "env": {
    "DEBUG": "1"
  }
}

ExecStream#

Run a command and stream its output as it is produced.

POST/upstream.platform.v1.Platform/ExecStream

Server-streaming: the response is a stream of ExecEvent messages.

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`command`	string[]	Program and arguments.
`workingDir`	string	Directory to run in. Defaults to the sandbox's working directory.
`env`	map<string, string>	Environment variables.

Response

Field	Type	Description
`stdout` one of event	bytes (base64)	Standard output.
`stderr` one of event	bytes (base64)	Standard error.
`exitCode` one of event	integer	Exit status of the command.

example request

{
  "sandboxId": "sb_7f3a2c",
  "command": [
    "python3",
    "-c",
    "print('hello')"
  ],
  "workingDir": "/workspace",
  "env": {
    "DEBUG": "1"
  }
}

BatchExec#

Run several commands in one request.

POST/upstream.platform.v1.Platform/BatchExec

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`commands`	BatchExecCommand[]

Response

Field	Type	Description
`results`	ExecResponse[]

example request

{
  "sandboxId": "sb_7f3a2c",
  "commands": [
    {
      "command": [
        "python3",
        "-c",
        "print('hello')"
      ],
      "workingDir": "/workspace",
      "env": {
        "DEBUG": "1"
      }
    }
  ]
}

ListProcesses#

List processes running in the background.

POST/upstream.platform.v1.Platform/ListProcesses

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.

Response

Field	Type	Description
`processes`	ProcessInfo[]

example request

{
  "sandboxId": "sb_7f3a2c"
}

Signal#

Send a signal to a process in the sandbox.

POST/upstream.platform.v1.Platform/Signal

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`pid`	integer	Process ID inside the sandbox.
`signal`	integer

Response

No fields.

example request

{
  "sandboxId": "sb_7f3a2c",
  "pid": 4242,
  "signal": 15
}

Files#

ReadFile#

Read a file.

POST/upstream.platform.v1.Platform/ReadFile

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`path`	string	Absolute path inside the sandbox.

Response

Field	Type	Description
`content`	bytes (base64)	File contents.

example request

{
  "sandboxId": "sb_7f3a2c",
  "path": "/workspace/main.py"
}

WriteFile#

Write a file, creating it if needed.

POST/upstream.platform.v1.Platform/WriteFile

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`path`	string	Absolute path inside the sandbox.
`content`	bytes (base64)	File contents.

Response

No fields.

example request

{
  "sandboxId": "sb_7f3a2c",
  "path": "/workspace/main.py",
  "content": "cHJpbnQoJ2hlbGxvJyk="
}

ListFiles#

List a directory.

POST/upstream.platform.v1.Platform/ListFiles

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`path`	string	Absolute path inside the sandbox.

Response

Field	Type	Description
`entries`	FileEntry[]

example request

{
  "sandboxId": "sb_7f3a2c",
  "path": "/workspace/main.py"
}

StatFile#

Get a file's size, type and timestamps.

POST/upstream.platform.v1.Platform/StatFile

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`path`	string	Absolute path inside the sandbox.

Response

Field	Type	Description
`name`	string
`size`	integer (string)
`mode`	integer
`isDir`	boolean
`modifiedMs`	integer (string)

example request

{
  "sandboxId": "sb_7f3a2c",
  "path": "/workspace/main.py"
}

MakeDir#

Create a directory.

POST/upstream.platform.v1.Platform/MakeDir

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`path`	string	Absolute path inside the sandbox.
`recursive`	boolean	Apply to directory contents too.

Response

No fields.

example request

{
  "sandboxId": "sb_7f3a2c",
  "path": "/workspace/main.py",
  "recursive": false
}

Remove#

Remove a file or directory.

POST/upstream.platform.v1.Platform/Remove

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`path`	string	Absolute path inside the sandbox.
`recursive`	boolean	Apply to directory contents too.

Response

No fields.

example request

{
  "sandboxId": "sb_7f3a2c",
  "path": "/workspace/main.py",
  "recursive": false
}

Rename#

Rename or move a file or directory.

POST/upstream.platform.v1.Platform/Rename

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`oldPath`	string
`newPath`	string

Response

No fields.

example request

{
  "sandboxId": "sb_7f3a2c",
  "oldPath": "/workspace/draft.py",
  "newPath": "/workspace/main.py"
}

BatchWriteFiles#

Write several files in one request.

POST/upstream.platform.v1.Platform/BatchWriteFiles

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`files`	BatchFile[]

Response

Field	Type	Description
`results`	BatchWriteResult[]

example request

{
  "sandboxId": "sb_7f3a2c",
  "files": [
    {
      "path": "/workspace/main.py",
      "data": "…"
    }
  ]
}

BatchFileOps#

Apply a mix of file operations in one request.

POST/upstream.platform.v1.Platform/BatchFileOps

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`ops`	FileOp[]

Response

Field	Type	Description
`results`	FileOpResult[]

example request

{
  "sandboxId": "sb_7f3a2c",
  "ops": [
    {
      "read": {
        "sandboxId": "sb_7f3a2c",
        "path": "/workspace/main.py"
      }
    }
  ]
}

WatchFiles#

Stream filesystem changes under a path.

POST/upstream.platform.v1.Platform/WatchFiles

Server-streaming: the response is a stream of FileWatchEvent messages.

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`path`	string	Absolute path inside the sandbox.
`recursive`	boolean	Apply to directory contents too.

Response

Field	Type	Description
`eventType`	string	"created", "modified", "deleted", "renamed"
`path`	string	Absolute path inside the sandbox.
`isDir`	boolean
`timestampMs`	integer (string)

example request

{
  "sandboxId": "sb_7f3a2c",
  "path": "/workspace/main.py",
  "recursive": false
}

GetDownloadUrl#

Get a pre-signed URL for downloading a file.

POST/upstream.platform.v1.Platform/GetDownloadUrl

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`path`	string	Absolute path inside the sandbox.

Response

Field	Type	Description
`url`	string	URL.

example request

{
  "sandboxId": "sb_7f3a2c",
  "path": "/workspace/main.py"
}

GetUploadUrl#

Get a pre-signed URL for uploading a file.

POST/upstream.platform.v1.Platform/GetUploadUrl

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`path`	string	Absolute path inside the sandbox.

Response

Field	Type	Description
`url`	string	URL.

example request

{
  "sandboxId": "sb_7f3a2c",
  "path": "/workspace/main.py"
}

Ports and MCP#

ExposePort#

Expose a port from inside the sandbox through the gateway. Returns its URL.

POST/upstream.platform.v1.Platform/ExposePort

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`port`	integer	Port inside the sandbox.

Response

Field	Type	Description
`url`	string	URL.
`port`	integer	Port inside the sandbox.

example request

{
  "sandboxId": "sb_7f3a2c",
  "port": 8000
}

UnexposePort#

Stop exposing a port.

POST/upstream.platform.v1.Platform/UnexposePort

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`port`	integer	Port inside the sandbox.

Response

No fields.

example request

{
  "sandboxId": "sb_7f3a2c",
  "port": 8000
}

ListPorts#

List a sandbox's exposed ports.

POST/upstream.platform.v1.Platform/ListPorts

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.

Response

Field	Type	Description
`ports`	PortInfo[]

example request

{
  "sandboxId": "sb_7f3a2c"
}

GetMcpInfo#

Get connection details for the sandbox's MCP proxy.

POST/upstream.platform.v1.Platform/GetMcpInfo

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.

Response

Field	Type	Description
`url`	string	URL.
`servers`	McpServerInfo[]

example request

{
  "sandboxId": "sb_7f3a2c"
}

Templates#

ListTemplates#

List built-in and custom templates.

POST/upstream.platform.v1.Platform/ListTemplates

Request

No fields.

Response

Field	Type	Description
`templates`	TemplateInfo[]

example request

{}

GetTemplate#

Get a custom template.

POST/upstream.platform.v1.Platform/GetTemplate

Request

Field	Type	Description
`name`	string

Response

Field	Type	Description
`id`	string
`name`	string
`status`	string	Current status.
`specJson`	string	Template spec as JSON, e.g. {"dockerfile": "FROM …"}.
`createdAt`	string	RFC 3339 timestamp.

example request

{
  "name": "my-env"
}

CreateTemplate#

Create a custom template from a Dockerfile.

POST/upstream.platform.v1.Platform/CreateTemplate

Request

Field	Type	Description
`name`	string
`specJson`	string	Template spec as JSON, e.g. {"dockerfile": "FROM …"}.

Response

Field	Type	Description
`id`	string
`name`	string
`status`	string	Current status.
`specJson`	string	Template spec as JSON, e.g. {"dockerfile": "FROM …"}.
`createdAt`	string	RFC 3339 timestamp.

example request

{
  "name": "my-env",
  "specJson": "{\"dockerfile\":\"FROM python:3.12-slim\\nRUN pip install pandas\"}"
}

DeleteTemplate#

Delete a custom template.

POST/upstream.platform.v1.Platform/DeleteTemplate

Request

Field	Type	Description
`name`	string

Response

No fields.

example request

{
  "name": "my-env"
}

Volumes#

CreateVolume#

Create a persistent volume that sandboxes can mount.

POST/upstream.platform.v1.Platform/CreateVolume

Request

Field	Type	Description
`name`	string
`sizeGib`	integer (string)

Response

Field	Type	Description
`volume`	VolumeInfo

example request

{
  "name": "my-env",
  "sizeGib": 1
}

ListVolumes#

List your volumes.

POST/upstream.platform.v1.Platform/ListVolumes

Request

No fields.

Response

Field	Type	Description
`volumes`	VolumeInfo[]

example request

{}

GetVolume#

Get a volume.

POST/upstream.platform.v1.Platform/GetVolume

Request

Field	Type	Description
`id`	string

Response

Field	Type	Description
`volume`	VolumeInfo

example request

{
  "id": "…"
}

DeleteVolume#

Delete a volume.

POST/upstream.platform.v1.Platform/DeleteVolume

Request

Field	Type	Description
`id`	string

Response

No fields.

example request

{
  "id": "…"
}

Observability#

GetMetrics#

Get a sandbox's CPU, memory and disk usage.

POST/upstream.platform.v1.Platform/GetMetrics

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.

Response

Field	Type	Description
`metrics`	MetricEntry[]

example request

{
  "sandboxId": "sb_7f3a2c"
}

GetLogs#

Get a sandbox's logs.

POST/upstream.platform.v1.Platform/GetLogs

Request

Field	Type	Description
`sandboxId`	string	Sandbox ID.
`since`	integer (string)	Start of the range, RFC 3339.

Response

Field	Type	Description
`logs`	LogEntry[]

example request

{
  "sandboxId": "sb_7f3a2c",
  "since": "2026-10-01T00:00:00Z"
}

ListEvents#

List lifecycle events such as sandbox.created and sandbox.forked.

POST/upstream.platform.v1.Platform/ListEvents

Request

Field	Type	Description
`offset`	integer (string)
`limit`	integer (string)
`type`	string	filter by event type
`sandboxId`	string	Sandbox ID.

Response

Field	Type	Description
`events`	SandboxEvent[]

example request

{
  "offset": 0,
  "limit": 50,
  "type": "…",
  "sandboxId": "sb_7f3a2c"
}

GetUsage#

Get compute used over a time range.

POST/upstream.platform.v1.Platform/GetUsage

Request

Field	Type	Description
`since`	string	Start of the range, RFC 3339.
`until`	string	End of the range, RFC 3339.

Response

Field	Type	Description
`totalSessions`	integer (string)
`totalVcpuSeconds`	number
`totalGibSeconds`	number
`totalDurationSeconds`	number

example request

{
  "since": "2026-10-01T00:00:00Z",
  "until": "2026-10-31T00:00:00Z"
}

Webhooks#

CreateWebhook#

Receive lifecycle events at your own URL.

POST/upstream.platform.v1.Platform/CreateWebhook

Request

Field	Type	Description
`name`	string
`url`	string	URL.
`secret`	string	Shared secret used to sign deliveries.
`eventTypes`	string[]	Event types to deliver, e.g. sandbox.forked. Empty means all.

Response

Field	Type	Description
`webhook`	WebhookInfo

example request

{
  "name": "my-env",
  "url": "https://example.com/hooks/upstream",
  "secret": "whsec_…",
  "eventTypes": [
    "sandbox.forked"
  ]
}

ListWebhooks#

List your webhooks.

POST/upstream.platform.v1.Platform/ListWebhooks

Request

No fields.

Response

Field	Type	Description
`webhooks`	WebhookInfo[]

example request

{}

DeleteWebhook#

Delete a webhook.

POST/upstream.platform.v1.Platform/DeleteWebhook

Request

Field	Type	Description
`id`	string

Response

No fields.

example request

{
  "id": "…"
}

Types#

Message types that appear inside requests and responses.

BatchExecCommand#

Field	Type	Description
`command`	string[]	Program and arguments.
`workingDir`	string	Directory to run in. Defaults to the sandbox's working directory.
`env`	map<string, string>	Environment variables.

BatchFile#

Field	Type	Description
`path`	string	Absolute path inside the sandbox.
`data`	bytes (base64)

BatchWriteResult#

Field	Type	Description
`path`	string	Absolute path inside the sandbox.
`ok`	boolean
`error`	string

FileEntry#

Field	Type	Description
`name`	string
`isDir`	boolean
`size`	integer (string)

FileOp#

Field	Type	Description
`read` one of op	ReadFileRequest
`write` one of op	WriteFileRequest
`list` one of op	ListFilesRequest
`stat` one of op	StatFileRequest
`mkdir` one of op	MakeDirRequest
`remove` one of op	RemoveRequest

FileOpResult#

Field	Type	Description
`read` one of result	ReadFileResponse
`write` one of result	WriteFileResponse
`list` one of result	ListFilesResponse
`stat` one of result	StatFileResponse
`mkdir` one of result	MakeDirResponse
`remove` one of result	RemoveResponse
`error` one of result	string

LogEntry#

Field	Type	Description
`timestamp`	integer (string)	unix millis
`stream`	string	"stdout" or "stderr"
`message`	string

McpServerInfo#

Field	Type	Description
`name`	string
`command`	string	Program and arguments.
`args`	string[]

MetricEntry#

Field	Type	Description
`name`	string
`value`	number
`timestamp`	integer (string)	unix millis

PortInfo#

Field	Type	Description
`port`	integer	Port inside the sandbox.
`url`	string	URL.

ProcessInfo#

Field	Type	Description
`pid`	integer	Process ID inside the sandbox.
`command`	string	Program and arguments.
`cwd`	string

SandboxEvent#

Field	Type	Description
`eventId`	string
`type`	string
`sandboxId`	string	Sandbox ID.
`timestamp`	string	RFC3339
`payload`	string	JSON

SnapshotInfo#

Field	Type	Description
`id`	string
`sandboxId`	string	Sandbox ID.
`label`	string	Human-readable label.
`template`	string	Template name.
`createdAt`	string	RFC 3339 timestamp.

TemplateInfo#

Field	Type	Description
`name`	string
`defaultVcpu`	integer
`defaultMemoryMib`	integer

VolumeInfo#

Field	Type	Description
`id`	string
`name`	string
`sizeGib`	integer (string)
`status`	string	Current status.
`attachedSandbox`	string
`createdAt`	string	RFC 3339 timestamp.

VolumeMountSpec#

Field	Type	Description
`volumeId`	string	Volume ID.
`mountPath`	string	Where to mount the volume inside the sandbox.
`readOnly`	boolean	Mount read-only.

WebhookInfo#

Field	Type	Description
`id`	string
`name`	string
`url`	string	URL.
`eventTypes`	string[]	Event types to deliver, e.g. sandbox.forked. Empty means all.
`createdAt`	string	RFC 3339 timestamp.