Sandbox API

Restart a sandbox

post/workspaces/{workspace_domain}/sandboxes/{sandbox_id}/restart

Path parameters

workspace_domainstring required

Example:my-company

The human-readable ID of the workspace

sandbox_idstring required

Example:sb-1234567890abcdef

The ID of the sandbox

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

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

scope'PROJECT' | 'ENVIRONMENT' | 'WORKSPACE'

The scope of the sandbox: PROJECT, ENVIRONMENT, or WORKSPACE

notestring

Note for this resource

agent_notestring

YAML note for AI agents operating on this resource

Example response

{
  "project": {
    "name": "my-project",
    "display_name": "My Project"
  },
  "environment": {
    "name": "staging",
    "identifier": "my-staging",
    "scope": "PROJECT"
  }
}

Changes

Changed in 5 of the 8 revisions of this API.158

Aug 25, 2026fa785a68f09d2See the full diff
- ○
  the security scope SANDBOX_WRITE was added to the endpoint's security scheme oauth2
  api-security-scope-added
- ○
  the security scope SANDBOX_MANAGE was removed from the endpoint's security scheme oauth2
  api-security-scope-removed
Aug 18, 2026983f489a99d21See the full diff
- ●
  added the new OPENCODE enum value to the project/integration/type response property for the response status 200
  response-property-enum-value-added
Aug 11, 2026c72dad76b50c122See the full diff
- ▲
  the response property endpoints/items/region became optional for the status 200
  response-property-became-optional
- ●
  added the new CURSOR enum value to the project/integration/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new OPEN_AI enum value to the project/integration/type response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property environment to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property scope to the response with the 200 status
  response-optional-property-added
Aug 4, 20262426d67c249a14See the full diff
- ●
  removed the optional property variables/items/description from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property agent_note to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property note to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property variables/items/agent_note to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property variables/items/note to the response with the 200 status
  response-optional-property-added
Jul 26, 20262de57f5e042f1See the full diff
- ●
  added the new GOOGLE_GEMINI enum value to the project/integration/type response property for the response status 200
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history