Search skmtc…
⌘K
Docs
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Generate
Filter operations
AdminGate
2
Agents
62
AI Applications
30
AI Chat
44
AI Gateway
14
AI Gateway Admin
12
AI Gateway Limits
5
AI Gateway Pricing
1
AI Gateway Usage
8
AI Provider Status
3
Alarms
14
Alerts
6
Analytics
43
Analytics Ingest Keys
6
API Keys
9
Audit Logs
2
Authentication
29
Autofixer
7
Backups
36
Blob
6
Blob Management
6
CI builder
3
CI runner
6
Cloud
8
Compose
3
Containers
8
Crons
3
Custom Domains
8
Dashboards
5
Deployment Tokens
6
Deployments
25
DNS
1
DNS Providers
14
DNS Records
4
Domains
19
Email Domains
12
Email Providers
9
Email Tracking
7
Email Validation
1
Emails
5
Environments
2
error-alert-rules
5
error-tracking
10
Events
13
External Images
7
External Services
50
External Services - Query
11
Feature Flags
9
Files
1
Funnels
7
GenAI
2
geo
2
Git Provider Connections
3
Git Providers
35
HTTP Checks
12
Imports
5
Insights
1
Internal DNS
2
IP Access Control
6
KV Management
6
KV Store
7
Load Balancer
5
Logs
11
Metrics
17
Nodes
28
Notification Preferences
4
Notification Providers
15
Notification Routes
7
Observability
2
Operations
1
OTel
15
OTel Facets
4
OTel Ingest
6
Performance
6
Platform
6
Postgres Upgrades
7
Presets
2
Preview Gateway
6
Project Groups
22
Project IP Access
8
Projects
47
Proxy Logs
14
Public Repositories
6
Repositories
6
Restore
6
Revenue
16
Runtime health
3
Sandboxes
40
get
/v1/sandboxes
post
/v1/sandboxes
get
/v1/sandboxes/placement
List the nodes sandboxes can be placed on and the operator allow-list.
put
/v1/sandboxes/placement
Set which nodes may run new sandboxes. Admin only.
get
/v1/sandboxes/placement/nodes/{node}
List every live sandbox on one node, from all owners. Admin only: it exposes other users' sandboxes.
post
/v1/sandboxes/placement/nodes/{node}/evict
Destroy every live sandbox on a worker node, from all owners, so the node can be removed. Works on a node that is offline for good: its sandboxes are marked destroyed even when the node cannot be reached. Admin only.
get
/v1/sandboxes/rootfs
Inspect rootfs storage: the Firecracker digest-keyed cache (with which sandboxes reference each entry) and per-VM disks. Empty on Docker-only hosts. Admin/read scope — this exposes host storage layout.
post
/v1/sandboxes/rootfs/gc
Reclaim rootfs cache entries not backing any live sandbox. Idempotent; safe to call any time (live VMs hold their own per-VM disks).
get
/v1/sandboxes/{id}
post
/v1/sandboxes/{id}/cmd
Run a command inside the sandbox (`@vercel/sandbox`-compatible).
get
/v1/sandboxes/{id}/cmd/{cmd_id}
get
/v1/sandboxes/{id}/cmd/{cmd_id}/logs
Stream a command's stdout/stderr as `application/x-ndjson` (`@vercel/sandbox`-compatible). Each line is either `{stream:"stdout"|"stderr", data:"..."}` or `{stream:"error", data:{code, message}}`.
post
/v1/sandboxes/{id}/destroy
get
/v1/sandboxes/{id}/domain
get
/v1/sandboxes/{id}/events
The operations timeline for a sandbox (lifecycle events only — never shell/exec activity), newest first.
post
/v1/sandboxes/{id}/exec
post
/v1/sandboxes/{id}/exec-detached
post
/v1/sandboxes/{id}/extend-timeout
get
/v1/sandboxes/{id}/fs/list
post
/v1/sandboxes/{id}/fs/mkdir
get
/v1/sandboxes/{id}/fs/read
get
/v1/sandboxes/{id}/fs/stat
post
/v1/sandboxes/{id}/fs/write
Write a file into the sandbox. Accepts two body shapes — the SDK picks one based on `Content-Type`:
post
/v1/sandboxes/{id}/fs/write-batch
Batch-write multiple files in a single request. Mirrors `@vercel/sandbox` `writeFiles()`. Semantics are fail-fast: if any file errors, previously-written entries are left in place and the error describes which file broke.
get
/v1/sandboxes/{id}/jobs
get
/v1/sandboxes/{id}/jobs/{job_id}
post
/v1/sandboxes/{id}/jobs/{job_id}/kill
Terminate a detached job. Aborts the server-side tracking task and sends SIGTERM (or SIGKILL if `force=true`) to any matching processes inside the sandbox container. Returns 204 on success; 404 if the sandbox or job is unknown.
get
/v1/sandboxes/{id}/jobs/{job_id}/logs
SSE endpoint streaming each stdout/stderr line from a detached job as it's produced. Mirrors the `Command.logs()` async iterator shape on `@vercel/sandbox` — events carry `{ stream, data }`.
post
/v1/sandboxes/{id}/pause
post
/v1/sandboxes/{id}/preview-link
Mint a shareable link to a sandbox preview.
put
/v1/sandboxes/{id}/preview-password
delete
/v1/sandboxes/{id}/preview-password
post
/v1/sandboxes/{id}/resize
Grow a Firecracker sandbox's root disk. Offline resize — the VM reboots (filesystem/data persist) rather than resizing fully live.
post
/v1/sandboxes/{id}/restart
post
/v1/sandboxes/{id}/resume
post
/v1/sandboxes/{id}/runtime-environment
Issue the same scoped service variables used by a deployment runtime for the project attached to this sandbox.
post
/v1/sandboxes/{id}/source
post
/v1/sandboxes/{id}/stop
get
/v1/sandboxes/{id}/terminal
Attach an interactive terminal to a sandbox.
post
/v1/sandboxes/{id}/{cmd_id}/kill
Kill a running command (`@vercel/sandbox`-compatible). The SDK calls `POST /v1/sandboxes/{id}/{cmdId}/kill` — note the path has the command ID directly under the sandbox, NOT under `/jobs/` or `/cmd/`.
Secrets
7
sentry-compat
6
sentry-ingestor
3
Settings
16
Snapshots
5
source-maps
8
Static Bundles
4
Status Page
32
Teams
13
Telemetry
2
Telemetry Logs
1
Telemetry Metrics
4
Templates
7
Traces
8
Traefik Discovery
6
Traffic Delivery
11
Users
13
Visitor Activity
5
Vulnerability Scans
8
Webhook Deliveries
3
Webhooks
6
Workflows
1
get
/projects/{project_id}/dsns
List all DSNs for a project
post
/projects/{project_id}/dsns
Create a new DSN for a project
post
/projects/{project_id}/dsns/get-or-create
Get or create DSN for a project/environment/deployment combination
post
/projects/{project_id}/dsns/{dsn_id}/regenerate
Regenerate DSN keys (rotate keys)
post
/projects/{project_id}/dsns/{dsn_id}/revoke
Revoke (deactivate) a DSN
Sandboxes
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to GET /v1/sandboxes/:id/fs/list
get
/v1/sandboxes/{id}/fs/list
Oct 14, 2026
5cf062ead579
Revision changes
info
endpoint added