Create Sandbox YAML

POST
/workspaces
/:workspace
/sandboxes
/yaml

Creates a sandbox using YAML definition.

Request

REQUIRED SCOPES

WORKSPACE, SANDBOX_MANAGE

URL PARAMETERS

workspacerequired string

The workspace name.

GET PARAMETERS

project_namerequired string

The name ID of the project.

POST PARAMETERS

yamlrequired string

base64 encoded yaml definition of a sandbox

Last modified on Sep 10, 2025

Create New Sandbox from Snapshot Start Sandbox

Example:

curl -X POST "https://api.buddy.works/workspaces/:workspace/sandboxes/yaml" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "yaml": "LSBzYW5kYm94OiBzZXJ2aWNlX25naW54CiAgbmFtZTogU2VydmljZSBOZ2lueAogIG9zOiB1YnVudHU6MjQuMDQKICByZXNvdXJjZXM6IDF4MgogIGluc3RhbGxfY29tbWFuZHM6IHwtCiAgICBhcHQtZ2V0IHVwZGF0ZQogICAgYXB0LWdldCBpbnN0YWxsIC15IG5naW54CiAgdGFnczoKICAtIG9yYW5nZQogIC0gcmFic3BlcnJ5CiAgLSBvbGl2ZQogIC0gcHVycGxlCiAgcnVuX2NvbW1hbmQ6IG5naW54CiAgYXBwX3R5cGU6IFNFUlZJQ0UKICBlbmRwb2ludHM6CiAgLSBuYW1lOiB5cnRraW1rdnBqCiAgICBlbmRwb2ludDogODAKICAgIHJlZ2lvbjogRVUK"
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/sandboxes/llp9yhtmk0f8c",
  "html_url": "https://app.buddy.works/buddy/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",
  "setup_status": "CONFIGURING",
  "endpoints": [
    {
      "name": "yrtkimkvpj",
      "endpoint": "80",
      "type": "HTTP",
      "region": "EU",
      "timeout": 30,
      "http": {
        "verify_certificate": false,
        "compression": false,
        "http2": false,
        "log_requests": false
      }
    }
  ],
  "project": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/my-project",
    "html_url": "https://app.buddy.works/buddy/my-project",
    "name": "my-project",
    "display_name": "My Project",
    "status": "ACTIVE"
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999