KestrelDocs

API Reference

Make and manage sandboxes outside a run.

Create a sandbox

POST/v1/sandboxes

{ "repo": "acme/web-app", "timeout_ms": 600000, "from": "web-app-seeded" }

Run a command

POST/v1/sandboxes/{id}/commands

{ "cmd": "npm test -- checkout", "timeout_ms": 120000 }

Files

PUT/v1/sandboxes/{id}/files/{path}

GET/v1/sandboxes/{id}/files/{path}

Send and receive the raw bytes. For files over 100 MB, use the SDKs, which split them into parallel chunks.

Pause, resume, snapshot

POST/v1/sandboxes/{id}/pause

POST/v1/sandboxes/{id}/resume

POST/v1/sandboxes/{id}/snapshots

Kill a sandbox

DELETE/v1/sandboxes/{id}

Returns 204. A second call returns 409 conflict.

Was this page helpful?

Open the dashboard