API Referenceruntimes

Update a runtime

View as Markdown

Update a runtime: name and idleTimeoutSeconds any time, launch config only while the runtime is stopped.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

runtimeIdstringRequired
Unique runtime identifier generated by BCTRL.

Headers

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.

Request

This endpoint expects an object.
configobjectOptional
idleTimeoutSecondsintegerOptional60-3600
namestringOptional1-120 characters

Response

OK
activeRunIdstring or null
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
idstring
Unique runtime identifier generated by BCTRL.
namestring
profileboolean
spaceIdstring
Unique space identifier generated by BCTRL.
statusenum
type"browser"
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.
archivedAtdatetimeOptional
RFC 3339 timestamp with a UTC offset.
configobjectOptional
lastActivityAtdatetimeOptional
RFC 3339 timestamp with a UTC offset.
metadataobject or nullOptional
needsInputbooleanOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error