Read a cloud browser session
Read a cloud browser session: CustomDomain™ API reference in the cloud browser group. Covers request parameters, the request body, responses and error codes.
The session view. Every call is the popup's heartbeat: a session that is not polled for 90 seconds before approval is ended and its browser released. The response is Cache-Control: no-store, because the view can carry the live view address, which anyone holding can drive.
Authorization
browserSession The session token of one cloud browser sign in, returned by POST /browser-sessions:redeem. It binds one session, one connection and one workspace, lives at most as long as the session, and stops working the moment the session ends. It lives in the popup's memory only.
In: header
Path Parameters
The cloud browser session id, bs_ and 32 hex characters.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/browser-sessions/string"{ "id": "string", "state": "created", "provider": "string", "provider_name": "string", "vendor": "string", "domain": "string", "site": "string", "interactive": true, "live_view_url": "http://example.com", "live_view_origin": "string", "deadline": "2019-08-24T14:15:22Z", "plan": { "hash": "string", "base_hash": "string", "changes": [ { "op": "add", "type": "string", "name": "string", "old": "string", "new": "string", "ttl": 0, "priority": 0, "reason": "string" } ], "unchanged": 0, "approve_by": "2019-08-24T14:15:22Z" }, "manual": { "records": [ { "type": "string", "name": "string", "value": "string", "ttl": 0, "present": true } ], "guide_url": "string" }, "notice": "not_signed_in", "wrongAccount": { "account": "string", "tried": 1, "max": 0 }, "error": { "code": "string", "message": "string" }, "sign_in_viewport": { "width": 0, "height": 0 }, "work_viewport": { "width": 0, "height": 0 }, "sign_in_frame": 1, "signed_in_detected": true, "check": true, "signals": { "host": "string", "hostVerified": true, "field": { "kind": "username", "label": "string", "maxLength": 1 }, "codePrompt": { "kind": "sms", "digits": 4 }, "push": true, "linkPrompt": true, "social": [ "google" ], "passkey": true, "check": true, "formError": "string", "focus": { "x": 0, "y": 0, "w": 0, "h": 0 }, "viewport": { "w": 0, "h": 0 } }, "handback": { "reason": "code" }, "form": { "identifier": "email", "steps": [ { "fields": [ { "kind": "username", "selector": "string" } ], "submit": "string" } ], "social": { "google": "string", "apple": "string", "facebook": "string", "amazon": "string", "microsoft": "string", "github": "string", "property1": "string", "property2": "string" }, "passkeyAlt": "string", "emailLink": true, "continue": "string", "resend": "string", "forgotUrl": "http://example.com" }}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}