Skip to main content
GET

​
Path parameters

​
string
required
Computer ID (UUID).
​
string
required
Screen ID, or default for the boot screen.

​
Response

Returns the screen. An id that does not exist returns 404 — it is never resolved to the default, because acting on the wrong screen puts a click on somebody else’s desktop.

Authorizations

​
Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

​
id
string
required

Computer ID

​
screenId
string
required

Screen ID, or default for the boot screen.

Response

The screen

​
id
string

Screen identifier. The boot screen is always default.

Example:

"screen-1"

​
display
string

X display this screen runs on.

Example:

":100"

​
width
integer

Width in pixels.

Example:

1920

​
height
integer

Height in pixels.

Example:

1080

​
vnc_port
integer

VNC port for this screen.

Example:

6000

​
ws_port
integer

WebSocket port for this screen.

Example:

6081

​
default
boolean

True for the screen the computer boots with. It cannot be destroyed.

Example:

false