get_sandbox

GET

/v1/sessions/{session_id}/sandbox

const url = 'https://app.everruns.com/api/v1/sessions/example/sandbox';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.everruns.com/api/v1/sessions/example/sandbox

Get the current session sandbox status (lease, runtime image, network access).

Parameters

Path Parameters

session_id

required

string

Session ID

Responses

200

Managed sandbox status

application/json

Response body for the get_session_sandbox operation.

object

configured

required

Whether the session’s harness opts in to a managed sandbox at all.

boolean

created_at

Timestamp when this sandbox record was created (RFC 3339).

string | null

display_name

Human-readable sandbox label. Safe to render in user-facing messages.

string | null

exists

required

Whether a sandbox instance currently exists for this session (within its lease).

boolean

external_id

Provider-side sandbox identifier (workspace ID, container ID, etc.).

string | null

init_completed_at

Timestamp when sandbox initialization finished (RFC 3339); absent while still starting.

string | null

last_init_error

Most recent initialization error message; cleared on successful re-init.

string | null

metadata

Provider-specific metadata (URLs, ports, credentials envelopes).

object

provider

Sandbox provider (daytona, e2b, docker, etc.) when one is configured.

string | null

session_status

One of:

null
string

null

Current sandbox lifecycle status (starting, ready, error, released).

string

Allowed values: running paused

updated_at

Timestamp when this sandbox record was last updated (RFC 3339).

string | null

workspace_path

Absolute path of the sandbox workspace root (used to scope file operations).

string | null

Example

{
  "session_status": "running"
}

404

Session not found