Skip to main content
GET
/
metrics
Get the stats of the service
curl --request GET \
  --url https://sandbox.{domain}/metrics \
  --header 'E2b-Sandbox-Id: <e2b-sandbox-id>' \
  --header 'E2b-Sandbox-Port: <e2b-sandbox-port>' \
  --header 'X-Access-Token: <api-key>'
import requests

url = "https://sandbox.{domain}/metrics"

headers = {
    "E2b-Sandbox-Id": "<e2b-sandbox-id>",
    "E2b-Sandbox-Port": "<e2b-sandbox-port>",
    "X-Access-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {
    'E2b-Sandbox-Id': '<e2b-sandbox-id>',
    'E2b-Sandbox-Port': '<e2b-sandbox-port>',
    'X-Access-Token': '<api-key>'
  }
};

fetch('https://sandbox.{domain}/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.{domain}/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "E2b-Sandbox-Id: <e2b-sandbox-id>",
    "E2b-Sandbox-Port: <e2b-sandbox-port>",
    "X-Access-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.{domain}/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("E2b-Sandbox-Id", "<e2b-sandbox-id>")
	req.Header.Add("E2b-Sandbox-Port", "<e2b-sandbox-port>")
	req.Header.Add("X-Access-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://sandbox.{domain}/metrics")
  .header("E2b-Sandbox-Id", "<e2b-sandbox-id>")
  .header("E2b-Sandbox-Port", "<e2b-sandbox-port>")
  .header("X-Access-Token", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.{domain}/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["E2b-Sandbox-Id"] = '<e2b-sandbox-id>'
request["E2b-Sandbox-Port"] = '<e2b-sandbox-port>'
request["X-Access-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "ts": 123,
  "cpu_count": 123,
  "cpu_used_pct": 123,
  "mem_total": 123,
  "mem_used": 123,
  "disk_used": 123,
  "disk_total": 123,
  "mem_used_mib": 123,
  "mem_total_mib": 123
}
{
  "message": "<string>",
  "code": 123,
  "sandboxID": "<string>"
}

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

​
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

​
disk_used
integer<int64>

Used disk space in bytes

​
disk_total
integer<int64>

Total disk space in bytes

​
mem_used_mib
integer<int64>

Used virtual memory in MiB

​
mem_total_mib
integer<int64>

Total virtual memory in MiB