Sign in

v4

OpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Target API

Get the status of a single execution.

get/workspaces/{workspace_domain}/targets/execs/{exec_id}

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

exec_idstring required
Example:9214386e-7633-4d2b-ac66-fcfbaf5ea99b

Execution ID returned by the execute endpoint

Query parameters

waitinteger
Example:10000

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.

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

execution_idstring

The ID of the execution

target_idstring

The ID of the target

target_type'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'

The type of the target

proxy_target_idstring

The ID of the proxy target used to tunnel the connection

commandstring

The executed command

started_atstring date-time

The date and time when the execution started

finished_atstring date-time

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