Sandboxes

Sandboxes Volumes Regions Networking & ports

Templates & state

Templates Declarative builder Snapshots & persistence

Work inside

Processes & code execution Managed processes Filesystem Terminal & SSH

Platform

Runtimes Webhooks Billing Audit log API keys & auth

Clients

CLI AI agents Develop inside a sandbox

API Reference

API Reference

API reference

Every endpoint of the Platinum REST API, generated from the OpenAPI spec. Open any operation and send a real request from the playground.

audit1

GETOrg audit log (owner/admin; filters + pagination)

secrets8

DELETEDELETE /v1/secrets/{id}DELETEDELETE /v1/secrets/bindings/{id}GETGET /v1/secrets GETGET /v1/secrets/{id}PATCHPATCH /v1/secrets/{id}POSTPOST /v1/secrets POSTPOST /v1/secrets/{id}/versions POSTPOST /v1/secrets/bindings

volume-operations1

GETGET /v1/volume-operations/{id}

Sandboxes48

DELETEDELETE /v1/sandboxes/{id}DELETEDELETE /v1/sandboxes/{id}/expose/{port}DELETEDELETE /v1/sandboxes/{id}/secrets/{alias}DELETEDELETE /v1/sandboxes/{id}/snapshots/{snapId}GETGET /v1/sandboxes GETGET /v1/sandboxes/{id}GETGET /v1/sandboxes/{id}/agent GETGET /v1/sandboxes/{id}/children GETGET /v1/sandboxes/{id}/logs GETGET /v1/sandboxes/{id}/metrics GETGET /v1/sandboxes/{id}/network GETGET /v1/sandboxes/{id}/secrets GETGET /v1/sandboxes/{id}/snapshots GETGET /v1/sandboxes/{id}/usage GETGet one managed process (?wait_ms= to block until exit)GETInteractive terminal (WebSocket PTY)DELETEKill a process (record retained)GETList managed processes (incl. recently exited)PATCHPATCH /v1/sandboxes/{id}POSTPOST /v1/sandboxes POSTPOST /v1/sandboxes/{id}/agent/upgrade POSTPOST /v1/sandboxes/{id}/archive POSTPOST /v1/sandboxes/{id}/backup POSTPOST /v1/sandboxes/{id}/clone POSTPOST /v1/sandboxes/{id}/egress-policy POSTPOST /v1/sandboxes/{id}/expose POSTPOST /v1/sandboxes/{id}/expose/revoke POSTPOST /v1/sandboxes/{id}/fork POSTPOST /v1/sandboxes/{id}/network POSTPOST /v1/sandboxes/{id}/pause POSTPOST /v1/sandboxes/{id}/resize POSTPOST /v1/sandboxes/{id}/restore POSTPOST /v1/sandboxes/{id}/restore-from-backup POSTPOST /v1/sandboxes/{id}/resume POSTPOST /v1/sandboxes/{id}/snapshot POSTPOST /v1/sandboxes/{id}/ssh-keys POSTPOST /v1/sandboxes/{id}/start POSTPOST /v1/sandboxes/{id}/stop POSTPOST /v1/sandboxes/sweep-failed PUTPUT /v1/sandboxes/{id}/secrets GETRead process output by absolute offset POSTResize a PTY process’s window POSTRun a code snippet (python | bash | node | sh)POSTRun a command (argv, no shell)POSTSignal a process (group by default)POSTStart a managed process (outlives the request)GETStream process output (SSE)POSTWrite to a process’s stdin (or close it)

Files10

POSTCreate a directory (recursive, ?path= & ?mode=)DELETEDelete a file or directory (?recurse=true)GETDownload a file (raw bytes)GETFind files by name glob POSTFind-and-replace across files (sed -E)GETList a directory GETSearch file contents (recursive grep)GETStat a path (size, mode, mtime)PUTUpload a file (raw body, ?path= & ?mode=)GETWatch a directory for changes (SSE)

Templates14

DELETEDELETE /v1/templates/{id}GETGET /v1/templates GETGET /v1/templates/{id}PATCHPATCH /v1/templates/{id}POSTPOST /v1/templates POSTPOST /v1/templates/{id}/cancel POSTPOST /v1/templates/{id}/derive POSTPOST /v1/templates/{id}/materialize POSTPOST /v1/templates/from-build POSTPOST /v1/templates/from-build/presign POSTPOST /v1/templates/from-image POSTPOST /v1/templates/from-patch POSTPOST /v1/templates/from-snapshot POSTPOST /v1/templates/from-spec

Webhooks7

DELETEDELETE /v1/webhooks/{id}GETGET /v1/webhooks GETGET /v1/webhooks/{id}/deliveries PATCHPATCH /v1/webhooks/{id}POSTPOST /v1/webhooks POSTPOST /v1/webhooks/{id}/deliveries/{dlvId}/retry POSTPOST /v1/webhooks/{id}/test

Platform2

GETGET /v1/me GETGET /v1/regions