Skip to main content
POST
/
api
/
sandboxes
/
{id}
/
preview
Create Preview URL
curl --request POST \
  --url https://app.opencomputer.dev/api/sandboxes/{id}/preview \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "port": 123,
  "domain": "<string>",
  "authConfig": {}
}
'
{
  "id": "pv-abc123",
  "sandboxId": "sb-abc123",
  "hostname": "sb-abc123-p3000.preview.opencomputer.dev",
  "port": 3000,
  "sslStatus": "active",
  "createdAt": "2025-01-15T10:30:00Z"
}
Create a preview URL to expose a port from the sandbox.
id
string
required
Sandbox ID
port
integer
required
Container port (1–65535)
domain
string
Custom domain
authConfig
object
Authentication configuration
{
  "id": "pv-abc123",
  "sandboxId": "sb-abc123",
  "hostname": "sb-abc123-p3000.preview.opencomputer.dev",
  "port": 3000,
  "sslStatus": "active",
  "createdAt": "2025-01-15T10:30:00Z"
}