Stop Runtime

POST

/v2/runtimes/:runtimeId/stop

POST

/v2/runtimes/:runtimeId/stop

$ curl -X POST https://api.bctrl.ai/v2/runtimes/runtimeId/stop \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Successful

1 {
2   "activeRunId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "createdAt": "2024-06-15T09:00:00Z",
4   "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
5   "name": "User Session Runtime",
6   "status": "stopped",
7   "type": "browser",
8   "updatedAt": "2024-06-15T10:25:00Z",
9   "config": {
10     "browser": {
11       "profile": true
12     },
13     "extensions": [
14       "adblock-plus",
15       "dark-mode"
16     ],
17     "fingerprint": {
18       "browser": "Chrome",
19       "locale": "en-US",
20       "timezone": "America/New_York",
21       "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
22       "viewport": {
23         "width": 1920,
24         "height": 1080
25       }
26     },
27     "lifecycle": {
28       "idleTimeoutMinutes": 30,
29       "lastActivityAt": "2024-06-15T10:20:30Z"
30     },
31     "proxy": {
32       "id": "proxy-123",
33       "name": "US-East Proxy"
34     },
35     "stealth": "medium"
36   },
37   "metadata": {
38     "owner": "team-alpha",
39     "environment": "production"
40   }
41 }

Stop one runtime and return the simplified runtime detail resource.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

runtimeIdstringRequired

Response

Default Response

activeRunIdstring or nullformat: "uuid"

createdAtstring

idstringformat: "uuid"

namestring>=1 character

statusenum

Allowed values:

typeenum

Allowed values:

updatedAtstring

configobject or map from strings to any

metadataobject or null