Skip to navigation
API ReferenceRuns

Get a Run

View as Markdown
Get one run using the simplified run resource.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

runIdstringRequired
Unique run identifier generated by BCTRL.

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Query parameters

include"usage" or "machineAccess"Optional

usage: the Run’s usage; machineAccess: whether BCTRL machine channels or programs outside the browser were used (preview).

waitintegerOptional0-60Defaults to 0

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
connectionsobject or null
controlobject
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
endedAtdatetime or null
RFC 3339 timestamp with a UTC offset.
endReasonstring or null
idstring
Unique run identifier generated by BCTRL.
locationenum
Allowed values:
object"run"
recordingobject
resourceIdstring
Unique browser identifier generated by BCTRL.
resourceType"browser"
spaceIdstring
Unique space identifier generated by BCTRL.
startedAtdatetime or null
RFC 3339 timestamp with a UTC offset.
statusenum
taskIdstring or null
traceIdstring or null

W3C trace ID: GET /traces/{traceId} returns the span tree.

updatedAtdatetime
RFC 3339 timestamp with a UTC offset.
machineAccessobject or nullOptional

Preview, with include=machineAccess. null when the Run’s log is not complete enough to tell.

usageobjectOptional
warningslist of objectsOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error