Autodetect
GETPATCH
/surface/autodetectparamsread-onlyprogressread-onlyrefusalread-onlyreportread-onlyrunningwritablestartedAtread-only
Example response
{
"running": false
}Control24
GETPATCH
/surface/control24enabledwritablerunningread-only
Example response
{
"enabled": false,
"running": false
}Detected
GET
/surface/detectedNo fields observed on the reference rig.
Gestures
GETPATCH
/surface/gesturesconfirmDestructivewritabledoubleTapMswritable100–600longPressMswritable400–2000
Example response
{
"confirmDestructive": true,
"doubleTapMs": 300,
"longPressMs": 800
}Pages
GET
/surface/pagespagesread-only
Example response
{
"pages": [
{
"index": 0
}
]
}GETPATCH
/surface/pages/{index}e.g. /surface/pages/0
namewritableslotswritable
Example response
{
"name": "probe",
"slots": [
{
"index": 2,
"kind": "input"
}
]
}Preferences
GETPATCH
/surface/preferencesaccentwritableorange · amber · teal · ice · green · violet · red · magenta · cyan
bayMenuPositionwritabletop · right · bottom · left
confirmConfigApplywritabledensitywritableauto · compact · normal · comfortable
dismissedMissingKeywritableeqFillModewritablesummed · bands · off
eqTapwritablepre · post · both
finishwritablealuminium · graphite · black
hideUnpatchedwritablemodernChosenwritablenarrowOnOverflowwritableoccupiedPatchwritablewarn · unpatch
panelTapwritablepre · post · both
perfRefreshMswritable250–60000 mssendBuswritablestageStripEdgewritabletop · right · bottom · left
stripScribblewritablevalue · name
stylewritablevintage · modern
themewritabledark · hc · light
traceToolbarwritabletop · right · bottom · left
Example response
{
"accent": "orange",
"bayMenuPosition": "top",
"confirmConfigApply": true,
"density": "auto",
"dismissedMissingKey": "",
"eqFillMode": "summed",
"eqTap": "both",
"finish": "aluminium",
"hideUnpatched": false,
"modernChosen": false,
"narrowOnOverflow": false,
"occupiedPatch": "warn",
"panelTap": "both",
"perfRefreshMs": 1000,
"sendBus": null,
"stageStripEdge": "right",
"stripScribble": "value",
"style": "vintage",
"theme": "dark",
"traceToolbar": "top"
}Selection
GETPATCH
/surface/selectionchannelwritable
Example response
{
"channel": {
"index": 1,
"kind": "input"
}
}Touch
GETPATCH
/surface/touch/{kind}/{index}e.g. /surface/touch/input/1
touchedwritable
Example response
{
"touched": false
}