Skip to main content
POST
Create a live view URL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id_or_name
string
required

Browser session ID or name

Body

application/json
scope
enum<string>
default:read

read shows the browser without accepting input. control also lets the viewer drive the browser through the live view.

Available options:
read,
control
ttl_seconds
integer

Seconds until the URL expires. Omit to keep it valid until the browser is deleted.

Required range: 1 <= x <= 31536000
Example:

3600

Response

Live view URL

scope
enum<string>
required

read shows the browser without accepting input. control also lets the viewer drive the browser through the live view.

Available options:
read,
control
url
string
required

Live view URL. Treat it as a credential.

Example:

"https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/live?jwt=eyJhbGciOi..."

expires_at
string<date-time>

When the URL expires. Absent when it stays valid until the browser is deleted.