Sandboxes

Create an ephemeral sandbox.

Boots an isolated microVM. Ephemeral sandboxes are disposable: they stop at their idle or hard timeout and nothing on the rootfs persists past stop. Compute is billed per vCPU-hour and GB-hour of allocation while running.

post/v1/sandboxes

Request

  • Base URL: https://api.scalix.world
  • URL: https://api.scalix.world/v1/sandboxes
  • Auth: HTTP bearer

Request body

runtimestring nullable

Runtime image. node22 is available today; other values are rolling out and fail placement until their images ship.

resourcesobject

Resource shape. Defaults: 1 vCPU, 512 MB memory, 5 GB disk.

timeout_msinteger nullable

Hard lifetime in milliseconds (60000..86400000, default 300000). The sandbox also stops earlier at its idle timeout.

portsinteger[] nullable

Guest ports to expose.

sourceobject

{type: "git", url, branch?} clones a repository into the sandbox.

envobject

Environment variables for the guest.

Example request

{
  "runtime": "node22"
}

Response

Sandbox created (initially PROVISIONING)

idstring required
runtimestring required
statusstring required

PROVISIONING | RUNNING | STOPPING | STOPPED | FAILED | EXPIRED

status_reasonstring nullable

Human-readable reason for the current status (set on FAILED and idle-stop transitions).

vcpusinteger required
memory_mbinteger required
disk_gbinteger required
expires_atstring required

Example response

{
  "status": "RUNNING"
}

Changes

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