Skip to main content
POST
Start a sandbox

Authorizations

Authorization
string
header
required

Bearer token authentication. Provide your API token prefixed with "Bearer ", e.g. "Bearer your-api-token".

Body

application/json

Sandbox start request

Sandbox start request

lifetime
object
required
network_policy
object
required
spec
object
required
env
object
gatedFeatures
object

GatedFeatures contains optional feature settings restricted to administrators.

image_id
string

ImageID optionally selects a READY organization-owned container image. When omitted, the sandbox is a Firecracker VM without a container.

name
string

Name is an optional label. It must be free of any other live sandbox in the organization and defaults to the assigned ID. It never addresses a sandbox: requests are made by ID.

Response

Accepted

id
string
required
name
string
required