get_session_environment

GET

/v1/sessions/{session_id}/environment

const url = 'https://app.everruns.com/api/v1/sessions/example/environment';
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/environment

Get the environment a session runs in: target, containment, and what it can actually do.

Parameters

Path Parameters

session_id

required

string

Session ID

Responses

200

Resolved session environment

application/json

The environment a session is running in.

object

capabilities

required

What the environment can actually do.

Read this before assuming a shell behaves like Linux. Bashkit reports native_processes: false, which is why a build fails there; the answer is available before the first turn rather than after a confusing tool error.

object

native_processes

required

boolean

network_enforced

required

boolean

packages

required

boolean

portable_checkpoint

required

boolean

ports

required

boolean

pty

required

boolean

containment

required

What commands may touch, and who enforces it.

object

level

required

none, native, or isolated.

string

network

required

Outbound network policy: deny, allowlist, or allow.

string

durability

required

checkpointed, provider_snapshot, or none. Declared per target, so a session on somebody else’s machine is never reported as recoverable.

string

resolved_from

required

How this view was produced. capabilities means it was derived from the session’s effective capability set rather than read from a stored environment profile.

string

source_capability

Capability that supplied the compute, for operators tracing a surprise.

string | null

target

One of:

null
object

null

Target, absent when the session has no compute at all and only reads and writes files. That is a real configuration, not a misconfiguration.

object

kind

required

Shape of the target: host, machine, vfs, container, managed.

string

provider

Concrete provider, when the kind has one (bashkit, daytona, …).

string | null

Example

{
  "capabilities": {
    "native_processes": false,
    "network_enforced": true,
    "packages": false,
    "portable_checkpoint": true,
    "ports": false,
    "pty": false
  },
  "containment": {
    "level": "isolated",
    "network": "deny"
  },
  "durability": "checkpointed",
  "resolved_from": "capabilities",
  "source_capability": "bashkit_shell",
  "target": {
    "kind": "vfs",
    "provider": "bashkit"
  }
}

404

Session not found