Skip to main content
GET
/
sandboxes
List all sandboxes
curl --request GET \
  --url https://api-staging.superserve.ai/sandboxes \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "active",
    "vcpu_count": 123,
    "memory_mib": 123,
    "snapshot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "timeout_seconds": 123,
    "network": {
      "allow_out": [
        "api.openai.com",
        "*.github.com",
        "8.8.8.8/32"
      ],
      "deny_out": [
        "0.0.0.0/0"
      ]
    },
    "metadata": {
      "env": "prod",
      "owner": "agent-7"
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.superserve.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
metadata.{key}
string

Filter sandboxes whose metadata contains an exact {key}: <value> pair. Repeat with different keys to AND multiple filters. Values are always strings. Example: ?metadata.env=prod.

Response

List of sandboxes belonging to the authenticated team

​
id
string<uuid>
​
name
string
​
status
enum<string>

Current state of the sandbox. active means running; paused means paused and awaiting resume. resuming is a transient state observed while the platform restores a paused sandbox (e.g. via auto-resume on /exec); clients should retry shortly.

Available options:
active,
paused,
resuming
​
vcpu_count
integer
​
memory_mib
integer
​
snapshot_id
string<uuid>

ID of the latest snapshot (present after a pause).

​
created_at
string<date-time>
​
timeout_seconds
integer<int32>

Hard lifetime cap in seconds from creation, if set at creation time. Absent when no cap was configured.

​
network
object

Current egress allow/deny rules, if any have been configured. Absent when the sandbox uses default network settings.

​
metadata
object

User-supplied tags attached at creation. Always present — sandboxes created without metadata return {} rather than being absent.

Example:
{ "env": "prod", "owner": "agent-7" }