Skip to main content
POST
Get desktop streaming URL

Authorizations

Authorization
string
header
required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Path Parameters

boxId
string
required

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

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Query Parameters

vnc
enum<integer>

Use VNC/noVNC streaming mode.

Available options:
1
theme
enum<string>

Desktop streaming theme for non-VNC mode.

Available options:
light,
dark

Body

application/json

Optional desktop/VNC setup options used by the Box dashboard and CLI. Most callers send an empty body.

publicAccess
boolean
default:false

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

Response

Desktop streaming URL, or provisioning state for VNC setup.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Example:

"desktop.url"

success
boolean
desktopUrl
string<uri> | null

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

ip
string | null
mode
string
Example:

"vnc"

provisioning
boolean

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

message
string