Update Runtime | BCTRL Docs

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

{
  "activeRunId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2024-01-15T09:30:00Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Marketing Browser Runtime",
  "spaceId": "7e57d004-2b97-0e7a-b45f-5387367791cd",
  "status": "active",
  "type": "browser",
  "updatedAt": "2024-04-20T16:45:00Z",
  "config": {
    "profile": true,
    "autoUpgrade": true,
    "extensionIds": [
      "ext_adblocker123"
    ],
    "fingerprint": {
      "browser": "chrome",
      "locale": "en-US",
      "timezone": "America/New_York",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
      "viewport": {
        "height": 1080,
        "width": 1920
      }
    },
    "forceOpenShadowRoots": false,
    "idleTimeoutMinutes": 15,
    "networkTraffic": {
      "blockAds": true,
      "blockResourceTypes": [
        "media",
        "image"
      ],
      "blockTrackers": true,
      "saver": "medium",
      "urlAllowlist": [
        "https://trustedsite.com"
      ],
      "urlBlocklist": [
        "https://malicioussite.com"
      ]
    },
    "proxy": {
      "id": "proxy-12345",
      "name": "Corporate Proxy",
      "type": "custom"
    },
    "stealth": "high",
    "webRtcProxyOnly": false
  },
  "connectUrl": "wss://runtime.bctrl.ai/connect/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "lastActivityAt": "2024-04-20T16:45:00Z",
  "metadata": {},
  "protocol": "cdp"
}

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

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

runtimeIdstringRequired

Request

This endpoint expects an object.

configobjectOptional

idleTimeoutMinutesintegerOptional1-60

namestringOptional1-120 characters

Response

activeRunIdstring or nullformat: "uuid"

createdAtdatetime

idstringformat: "uuid"

namestring>=1 character

spaceIdstringformat: "uuid"

statusenum

type"browser"

updatedAtdatetime

configobject

connectUrlstringformat: "uri"

lastActivityAtdatetime

metadataobject or null

protocolenum

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error