Skip to main content
POST
/
sandbox-sessions
Create Sandbox Session
curl --request POST \
  --url https://api.veryfront.com/sandbox-sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ttl_hours": 12
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "short_id": "<string>",
  "endpoint": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ttl_hours": 1,
  "expires_at": "<string>",
  "created_at": "<string>",
  "last_activity_at": "<string>"
}

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<uuid>

Optional project ID. When set, the project owner is billed.

​
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