Get Sandbox Execution

View as Markdown

GET
/workspaces
/:workspace
/sandboxes
/:sandbox_id
/execs
/:exec_id

Get the status of a single execution.

Request

REQUIRED SCOPES

SANDBOX_READ

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

sandbox_idrequiredstring

The ID of the sandbox

Example: "sb-1234567890abcdef"

exec_idrequiredstring

Execution ID returned by the execute endpoint

Example: "9214386e-7633-4d2b-ac66-fcfbaf5ea99b"

GET PARAMETERS

waitinteger

Long-poll budget in ms. Omit to use the server default: the request is held until the execution reaches a terminal status, returning the current status once the budget elapses. Send 0 to return immediately. Clamped server-side.

Example: 10000

Response

RESPONSE BODY

typestring enum

The type of the execution: COMMAND (a command in the target's language) or MCP (an operation on the integration's MCP server)

Allowed enum:

COMMAND,

MCP

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

execution_idstring

The ID of the execution

target_idstring

The ID of the target

target_typestring enum

The type of the target

Allowed enum:

FTP,

SSH,

MATCH,

MATCH_ID,

VULTR,

DIGITAL_OCEAN,

UPCLOUD,

GIT,

ARTIFACT_VERSION,

GKE,

EKS,

AKS,

DOKS,

K8S_CLUSTER,

EC2,

AGENT,

SANDBOX,

MYSQL,

PROJECT_REPO,

POSTGRESQL,

MONGO,

MSSQL,

RDS_MSSQL,

CLICKHOUSE,

RDS_MYSQL,

RDS_POSTGRESQL

integrationstring

The hash ID of the integration the execution ran on (MCP executions)

sandboxstring

The ID of the sandbox the command ran in (sandbox executions)

runtimestring enum

The runtime the command ran with (sandbox executions)

Allowed enum:

BASH,

JAVASCRIPT,

TYPESCRIPT,

PYTHON

invokerMemberView

User/member reference

cancelled_byMemberView

User/member reference

proxy_target_idstring

The ID of the proxy target used to tunnel the connection

commandstring

The executed command; for an MCP execution the operation as canonical JSON

started_atstring

The date and time when the execution started

finished_atstring

The date and time when the execution finished

statusstring

The status of the execution. One of: INPROGRESS, SUCCESSFUL, FAILED, CANCELLED

failure_reasonstring

Platform-level reason a FAILED execution failed (absent for an ordinary non-zero exit): TIMEOUT (hard time cap reached), SPAWN_FAILED (execution could not be started), BASTION_FAILED (SSH bastion tunnel failed)

exit_codeinteger

The exit code of the executed command

bytes_outinteger

The size of the execution output in bytes

truncatedboolean

Indicates if the execution output was truncated

error_messagestring

The error message if the execution failed

log_urlstring

The URL to fetch the execution log

Last modified on Oct 27, 2026

Get Sandbox Content Get Sandbox Execution Log

Request example

CURL
curl -X GET "https://api.buddy.works/workspaces/:workspace/sandboxes/:sandbox_id/execs/:exec_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json"

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-1234567890abcdef/execs/5c2e8a14-3b7d-4f61-a9e0-6d4b1c8f2e73",
  "log_url": "https://api.buddy.works/workspaces/my-workspace/sandboxes/sb-1234567890abcdef/execs/5c2e8a14-3b7d-4f61-a9e0-6d4b1c8f2e73/log",
  "execution_id": "5c2e8a14-3b7d-4f61-a9e0-6d4b1c8f2e73",
  "sandbox": "sb-1234567890abcdef",
  "runtime": "BASH",
  "type": "COMMAND",
  "invoker": {
    "url": "https://api.buddy.works/workspaces/my-workspace/members/1",
    "id": 1,
    "name": "John Doe"
  },
  "command": "ls -la",
  "started_at": "2026-05-28T08:00:09.820Z",
  "finished_at": "2026-05-28T08:00:10.412Z",
  "status": "SUCCESSFUL",
  "exit_code": 0,
  "bytes_out": 412,
  "truncated": false
}

STATUS
200 OK