Get a browser and its current Run
Read a browser and its current Run. Use wait to wait for an accepted start or stop. Saved state remains private to the browser and is restored on its next Run.
Authentication
AuthorizationBearer
Use Bearer <api-key>.
Path parameters
browserId
Headers
BCTRL-Version
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-Space
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-Id
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
spaceId
wait
Response headers
BCTRL-Request-Id
Current request identifier, also echoed in errors.
BCTRL-Version
Negotiated dated API version.
RateLimit-Limit
Evaluated policy limit; zero when no finite policy was evaluated.
RateLimit-Remaining
Remaining policy budget; zero when no finite policy was evaluated.
RateLimit-Reset
Seconds until reset; zero when no finite policy was evaluated.
Response
OK
autoUpgrade
createdAt
RFC 3339 timestamp with a UTC offset.
currentRun
expireAfterIdleDays
extensions
forceOpenShadowRoots
gpu
headless
id
Unique browser identifier generated by BCTRL.
lastUsedAt
RFC 3339 timestamp with a UTC offset.
location
Compute location, or auto to choose the allowed live location (currently us-east).
metadata
name
object
recording
savedState
spaceId
Unique space identifier generated by BCTRL.
standbyAfterSeconds
Standby is currently disabled; use 0.
status
Allowed values:
stealth
Allowed values:
timeoutSeconds
type
updatedAt
RFC 3339 timestamp with a UTC offset.
viewport
webRtcProxyOnly
audit
Machine audit detail (preview).
captcha
copiedFrom
Preview. The browser this one was copied from (fromBrowser).
networkTraffic
proxy
warnings
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error

