Stop a live runtime inside a workspace

POST

/v1/workspaces/:id/runtimes/:alias/stop

POST

/v1/workspaces/:id/runtimes/:alias/stop

1 curl -X POST https://api.bctrl.ai/v1/workspaces/id/runtimes/alias/stop \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Successful

1 {
2   "alias": "runtime_01",
3   "createdAt": "2024-06-10T09:15:30Z",
4   "driver": "chromium",
5   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6   "kind": "browser",
7   "status": "stopped",
8   "updatedAt": "2024-06-10T09:20:00Z",
9   "workspaceId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
10   "summary": {
11     "browserRunning": false,
12     "currentDriver": "chromium",
13     "defaultContextId": "ctx_12345",
14     "defaultPageId": "page_67890",
15     "launchMode": "profile",
16     "profileId": "1c6b147e-8f3a-4d2a-9f3e-2a1b3c4d5e6f",
17     "storageWorkspace": "workspace_storage_01"
18   }
19 }

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

idstringRequired

aliasstringRequired

Response

Default Response

aliasstringformat: "^[A-Za-z][A-Za-z0-9_-]{0,63}$"

createdAtstring

driverstring>=1 character

idstringformat: "uuid"

kindenum

Allowed values:

statusenum

Allowed values:

updatedAtstring

workspaceIdstringformat: "uuid"

summaryobject or null