Sandboxes

List a sandbox's egress activity

The unified per-sandbox network log: every outbound connection the sandbox made, merged into one time-ordered stream, most recent first. Each row has a kind — connection (host, bytes, allow/deny verdict) or request (HTTP method, path, status, and the secret used, when a credential was injected). Fields not relevant to a row’s kind are omitted.

Filter by time window (since/before) and verdict. Paginate by passing the response’s next_cursor as before while has_more is true. A verdict filter returns only connection rows, since request rows carry no verdict.

GET

sandboxes

{sandbox_id}

network

List a sandbox's egress activity

curl --request GET \
  --url https://api.superserve.ai/sandboxes/{sandbox_id}/network \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.superserve.ai/sandboxes/{sandbox_id}/network"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.superserve.ai/sandboxes/{sandbox_id}/network', 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://api.superserve.ai/sandboxes/{sandbox_id}/network",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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://api.superserve.ai/sandboxes/{sandbox_id}/network"

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

	req.Header.Add("X-API-Key", "<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://api.superserve.ai/sandboxes/{sandbox_id}/network")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.superserve.ai/sandboxes/{sandbox_id}/network")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 123,
      "ts": "2023-11-07T05:31:56Z",
      "host": "<string>",
      "dst_ip": "<string>",
      "dst_port": 123,
      "match_rule": "<string>",
      "bytes_sent": 123,
      "bytes_recv": 123,
      "method": "<string>",
      "path": "<string>",
      "status": 123,
      "upstream_status": 123,
      "latency_ms": 123,
      "secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "error_code": "<string>"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

sandbox_id

string

required

The unique identifier of the sandbox. Public sandbox ID: a bare UUID, or the region-tagged form sb-<region>-<uuid> (e.g. sb-use-1b4e28ba-…). Treat as an opaque string; the tagged form routes the request to the sandbox's home region. Endpoints accept both forms interchangeably.

Pattern: ^(sb-[a-z0-9]+-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

limit

integer

default:50

Required range: 1 <= x <= 200

before

string

Pagination cursor or time filter. Pass the previous response's opaque next_cursor to page through results, or an RFC3339 timestamp to return rows strictly older than that time.

since

string<date-time>

Return rows at or newer than this RFC3339 timestamp.

verdict

enum<string>

Filter to connection rows with this verdict. Excludes request rows.

Available options:

allowed,

blocked,

failed

Response

A page of network events (most recent first)

A page of network events with pagination metadata.

data

object[]

required

Show child attributes

next_cursor

string | null

required

Opaque pagination cursor. Pass it verbatim as before to fetch the next page; do not parse it. Null when has_more is false.

has_more

boolean

required

Whether more rows exist beyond this page.

Activate a sandbox

Run a command and wait for it to finish

List a sandbox's egress activity

curl --request GET \
  --url https://api.superserve.ai/sandboxes/{sandbox_id}/network \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.superserve.ai/sandboxes/{sandbox_id}/network"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.superserve.ai/sandboxes/{sandbox_id}/network', 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://api.superserve.ai/sandboxes/{sandbox_id}/network",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <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://api.superserve.ai/sandboxes/{sandbox_id}/network"

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

	req.Header.Add("X-API-Key", "<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://api.superserve.ai/sandboxes/{sandbox_id}/network")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.superserve.ai/sandboxes/{sandbox_id}/network")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 123,
      "ts": "2023-11-07T05:31:56Z",
      "host": "<string>",
      "dst_ip": "<string>",
      "dst_port": 123,
      "match_rule": "<string>",
      "bytes_sent": 123,
      "bytes_recv": 123,
      "method": "<string>",
      "path": "<string>",
      "status": 123,
      "upstream_status": 123,
      "latency_ms": 123,
      "secret_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "error_code": "<string>"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}