Screens
Destroy a screen
Stop a screen and everything running on it.
DELETE
Stops the screen’s X server, its window manager, and every window on it. This
is not recoverable. The display number the screen was using is freed. The next
screen you create takes the lowest free
display number from
:100 up, so it reuses this one when no lower number is
free.
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. Must not be
default.Response
204 No Content with an empty body. There is nothing left to describe once the
screen is gone.
The screen is also dropped from the record Orgo keeps of the computer’s
screens, so a restart does not bring it back. That record is described in
Screens after a restart.
Errors
Failures raised before the request reaches the computer carryerror alone.
Failures relayed back from the computer add request_id and upstream_status.
This differs from get: a screen ID that does not
exist answers 409 here, not 404. Destroying the boot screen and destroying a
screen that was never there are both refusals. Both come back as 409, and the
message tells them apart.