Skip to main content
POST
Create Sandbox Session

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Body

application/json
project_id
string

Deprecated project ID or slug alias. Use project_reference.

project_reference
string

Optional project UUID or slug. When set, the project owner is billed.

projectId
string

Deprecated camelCase project ID or slug alias. Use project_reference.

environment_id
string<uuid>

Optional environment ID. When set, its variables are copied once into the sandbox session.

ttl_mode
enum<string>

Sandbox lifetime policy. default uses platform idle/max lifetime cleanup.

Available options:
default,
duration,
always_on
ttl_hours
integer

Required when ttl_mode is duration. Number of hours before cleanup, up to 24.

Required range: 0 < x <= 24

Response

Sandbox session created.

id
string<uuid>
required
short_id
string
required
endpoint
string
required
status
enum<string>
required
Available options:
pending,
provisioning,
running,
error,
deleting
project_id
string<uuid> | null
required
ttl_mode
enum<string>
required
Available options:
default,
duration,
always_on
ttl_hours
integer | null
required
Required range: x > 0
expires_at
string | null
required
created_at
string
required
last_activity_at
string | null
required