Skip to content
GitHub Get Started
HTTP API

Press a desktop keyboard shortcut.

POST
/v1/desktop/keyboard/press

Performs a health-gated xdotool key operation against the managed desktop.

object
key
required
string
modifiers
object
alt
boolean
nullable
cmd
boolean
nullable
ctrl
boolean
nullable
shift
boolean
nullable

Desktop keyboard action result

object
ok
required
boolean

Invalid keyboard press request

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

Desktop runtime is not ready

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

Desktop runtime health or input failed

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