v1

latestOpenAPI 3.1.02026-07-22304756.7 KB

Box

Get desktop streaming URL

Create or fetch a secret-bearing desktop/noVNC URL for live computer-use visibility. Use ?vnc=1 for noVNC; a provisioning: true response means poll again.

post/boxes/{boxId}/desktop

Path parameters

boxIdstring required

Public Box id returned by create/list/get box calls.

Query parameters

vnc1

Use VNC/noVNC streaming mode.

theme'light' | 'dark'

Desktop streaming theme for non-VNC mode.

Request body

publicAccessboolean

For ?vnc=1, return a noVNC URL that does not require an access token.

Response

Desktop streaming URL, or provisioning state for VNC setup.

okboolean required

typestring required

Stable success envelope discriminator added by v1.

successboolean

desktopUrlstring uri nullable

Secret-bearing desktop or noVNC URL. Redact from logs.

ipstring nullable

modestring

provisioningboolean

For ?vnc=1, true means VNC is still being prepared; poll again.

messagestring

Example response

{
  "ok": true,
  "type": "desktop.url",
  "mode": "vnc"
}