Skip to main content
GET
Service stats

Authorizations

X-Access-Token
string
header
required

Sandbox access token (envdAccessToken) for authenticating requests to a running sandbox. Returned by: POST /sandboxes (on create), POST /sandboxes/{sandboxID}/connect (on connect), POST /sandboxes/{sandboxID}/resume (on resume), and GET /sandboxes/{sandboxID} (for running or paused sandboxes).

Headers

E2b-Sandbox-Id
string
required

Identifier of the target sandbox. Routes the request to that sandbox's envd over the shared sandbox host.

E2b-Sandbox-Port
integer
default:49983
required

Port envd listens on inside the sandbox (default 49983).

Response

The resource usage metrics of the service

Resource usage metrics

ts
integer<int64>

Unix timestamp in UTC for current sandbox time

cpu_count
integer

Number of CPU cores online

cpu_possible
integer

Number of CPUs the guest can bring online

cpu_target
integer

Online count last requested, 0 when none was

cpu_target_attempts
integer

Attempts at reaching cpu_target since it was set

cpu_write_pending_ms
integer<int64>

How long a CPU online or offline write has been running in the guest kernel, 0 when none is. A value that keeps growing means CPU hotplug is stuck.

cpu_used_pct
number<float>

CPU usage percentage

mem_total
integer<int64>

Total virtual memory in bytes

mem_used
integer<int64>

Used virtual memory in bytes

mem_cache
integer

Cached memory (page cache) in bytes

disk_used
integer<int64>

Used disk space in bytes

disk_total
integer<int64>

Total disk space in bytes

oom_kills
object[]

The latest 32 out-of-memory kills since the guest booted, oldest first. Reading does not consume them. Empty when there are none. Omitted when not known (while envd is still reading the kernel log, when it can't be read or envd stopped reading it, and outside Firecracker).

mem_used_mib
integer<int64>

Used virtual memory in MiB

mem_total_mib
integer<int64>

Total virtual memory in MiB