Skip to main content
POST
Start a session

Authorizations

Authorization
string
header
required

API key with the vk_ prefix. Create one from the dashboard.

Body

application/json
environment_id
string
required
environment_version
integer<int32> | null

Pin a specific environment version (default: latest).

title
string | null
budget_usd
number<double> | null

Spend ceiling for this session in USD. The session pauses when its accrued cost reaches it.

Response

The new session

object
string
required
id
string
required
environment_id
string
required
environment_version
integer<int32>
required
status
string
required

provisioning | ready | running | paused | ended | failed

awake_seconds
integer<int64>
required

Seconds the sandbox has been awake (what the session meter bills).

total_cost_usd
number<double>
required

Charged so far (USD).

created_by
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
title
string | null
budget_usd
number<double> | null
started_at
string<date-time> | null
last_active_at
string<date-time> | null
paused_at
string<date-time> | null
ended_at
string<date-time> | null
failure_code
string | null
error_message
string | null