Skip to content
GitHub Get Started
HTTP API

Get desktop runtime status.

GET
/v1/desktop/status

Returns the current desktop runtime state, dependency status, active display metadata, and supervised process information.

Desktop runtime status

object
display
string
nullable
installCommand
string
nullable
lastError
object
code
required
string
message
required
string
missingDependencies
Array<string>
processes
Array<object>
object
logPath
string
nullable
name
required
string
pid
integer format: int32
nullable
running
required
boolean
resolution
object
dpi
integer format: int32
nullable
height
required
integer format: int32
width
required
integer format: int32
runtimeLogPath
string
nullable
startedAt
string
nullable
state
required
string
Allowed values: inactive install_required starting active stopping failed
windows

Current visible windows (included when the desktop is active).

Array<object>
object
height
required
integer format: int32
id
required
string
isActive
required
boolean
title
required
string
width
required
integer format: int32
x
required
integer format: int32
y
required
integer format: int32

Authentication required

object
detail
string
nullable
instance
string
nullable
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties