Start Sandbox

  • POST
  • /workspaces
  • /:workspace
  • /sandboxes
  • /:sandbox_id
  • /start

Starts a sandbox.

Request

REQUIRED SCOPES
WORKSPACE, SANDBOX_MANAGE
URL PARAMETERS
workspacerequired string
The workspace name.
sandbox_idrequired string
The ID of the sandbox.

Last modified on Sep 4, 2025

Example:

curl -X POST "https://api.buddy.works/workspaces/:workspace/sandboxes/:sandbox_id/start" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{}'
EXAMPLE RESPONSE
{ "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/llp9yhtmk0f8c", "html_url": "https://app.buddy.works/my-workspace/first-project/sandboxes/llp9yhtmk0f8c", "id": "llp9yhtmk0f8c", "identifier": "service_nginx", "name": "Service Nginx", "status": "STARTING", "os": "ubuntu:24.04", "resources": "1x2", "install_commands": "apt-get update\napt-get install -y nginx", "run_command": "nginx", "app_type": "SERVICE", "tags": [ "orange", "rabsperry", "olive", "purple" ], "app_status": "NONE", "boot_logs": [ "Sandbox starting..." ], "setup_status": "DONE", "endpoints": [ { "name": "yrtkimkvpj", "endpoint": "80", "type": "HTTP", "region": "EU", "timeout": 30, "http": { "verify_certificate": false, "compression": false, "http2": false, "log_requests": false } } ] }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999