Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Sandbox API

Execute a command in a sandbox

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

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

Request body

commandstring required

Command to execute in the sandbox

runtime'BASH' | 'JAVASCRIPT' | 'TYPESCRIPT' | 'PYTHON'

Runtime environment for command execution (default: BASH)

Example request

{
  "command": "ls -la"
}

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

idstring

The ID of the command

commandstring

Command to execute in the sandbox

runtime'BASH' | 'JAVASCRIPT' | 'TYPESCRIPT' | 'PYTHON'

Runtime environment for command execution (default: BASH)

status'INPROGRESS' | 'SUCCESSFUL' | 'FAILED'

Command execution status

exit_codeinteger

Command exit code

start_datestring date-time

Command execution start date

finish_datestring date-time

Command execution finish date

logs_urlstring

API endpoint URL to retrieve logs for this command