API Referenceruntimes

Stop a runtime

View as Markdown
Stop one runtime and return a flat teardown acknowledgement.

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.

Response

OK
runIdstring or null
runtimeIdstring
Unique runtime identifier generated by BCTRL.
statusenum
stoppedboolean

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error