Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Sandbox API

Create a new sandbox

post/workspaces/{workspace_domain}/sandboxes

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

Query parameters

project_namestring required
Example:my-project

The human-readable ID of the project to filter sandboxes

Request body

OR
OR

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

idstring

The ID of the sandbox

identifierstring

A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end).

namestring

The name of the sandbox

status'STARTING' | 'STOPPING' | 'FAILED' | 'RUNNING' | 'STOPPED' | 'RESTORING'

The current status of the sandbox

setup_status'INPROGRESS' | 'SUCCESS' | 'FAILED' | 'STALE'

The current setup status of the sandbox

osstring

The operating system of the sandbox ["ubuntu:22.04", "ubuntu:24.04"]

resources'1x2' | '2x4' | '3x6' | '4x8' | '5x10' | '6x12' | '7x14' | '8x16' | '9x18' | '10x20' | '11x22' | '12x24' | 'CUSTOM'

The resource configuration of the sandbox (CPU x RAM)

first_boot_commandsstring

The commands to run during first boot of the sandbox

app_dirstring

The application directory of the sandbox

timeoutinteger

The timeout in seconds after which the sandbox will be automatically stopped

tagsstring[]

The list of tags associated with the sandbox

boot_logsstring[]

The boot logs of the sandbox

ssh_hoststring

The SSH hostname

ssh_portinteger

The SSH port

Example response

{
  "project": {
    "name": "my-project",
    "display_name": "My Project"
  }
}