Skip to main content
PATCH
Resizes a screen in place with xrandr, so the X server is not restarted and every window already open on the screen is kept.

​
Path parameters

​
string
required
Computer ID (UUID). The computer must be up. One that is still being created, or that has been frozen, returns 400.
​
string
required
Screen ID, or default for the boot screen.

​
Body parameters

​
integer
required
New width in pixels. Must be 1 or greater.
​
integer
required
New height in pixels. Must be 1 or greater.
Both are required here, unlike create, which falls back to the size of the boot screen. A resize is an explicit change, so there is no fallback. A missing, zero, or negative dimension is refused with 400 and the message width and height are required.

​
Response

Returns the screen with its new width and height. Every other field is unchanged: resizing does not move a screen to a different display, and its vnc_port and ws_port stay where they were.

​
Errors

Failures raised before the request reaches the computer carry error alone. Failures relayed back from the computer add request_id and upstream_status.
Resizing a screen ID that does not exist answers 500 with no screen "<id>", not 404. Get is the reliable existence check: it answers 404 for an unknown screen.

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.

Body

application/json

The new size. Both dimensions are required here, unlike creating a screen. There is no boot screen to fall back to when the intent is an explicit change.

​
width
integer
required

New width in pixels.

Required range: x >= 1
Example:

1280

​
height
integer
required

New height in pixels.

Required range: x >= 1
Example:

720

Response

The resized screen. Every other field is unchanged: a resize does not move a screen to another display, and its ports stay where they were.

​
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