Skip to main content
POST
Start a sandbox session

Authorizations

Authorization
string
header
required

Use JWT token for authentication

Path Parameters

environmentId
string
required

Environment id

Body

application/json
timeoutMinutes
number

Session length in minutes (1-30, default 10). autoExtend on the environment renews it while the session is in use.

Example:

10

tenantId
string

Start from THIS tenant's snapshot. Only meaningful when the environment has per-tenant snapshots enabled.

force
boolean

Take over an already-active session, discarding its unsaved state. Without it a second concurrent session returns 409 SESSION_ACTIVE.

forceUnsavedSnapshot
boolean

Start from the last saved version even though a snapshot save is still running. The session may be missing what that save commits.

Response

Session started. Returns sandboxId, runtime and expiresAt.