REST reference

/surface

8 addresses under /surface.All families · Refusal codes

Autodetect

GETPATCH/surface/autodetect

paramsread-only
progressread-only
refusalread-only
reportread-only
runningwritable
startedAtread-only

Example response

{
  "running": false
}

Detected

GET/surface/detected

No fields observed on the reference rig.

Gestures

GETPATCH/surface/gestures

confirmDestructivewritable
doubleTapMswritable100–600
longPressMswritable400–2000

Example response

{
  "confirmDestructive": true,
  "doubleTapMs": 300,
  "longPressMs": 800
}

Pages

GET/surface/pages

pagesread-only

Example response

{
  "pages": []
}

GET/surface/pages/{index}

e.g. /surface/pages/1

No fields observed on the reference rig.

Preferences

GETPATCH/surface/preferences

bayMenuPositionwritable
top · left · right
confirmConfigApplywritable
densitywritable
auto · compact · normal · comfortable
dismissedMissingKeywritable
eqFillModewritable
summed · bands · off
eqTapwritable
pre · post · both
hideUnpatchedwritable
narrowOnOverflowwritable
occupiedPatchwritable
warn · unpatch
panelTapwritable
pre · post · both
processingPanelwritable
sendBuswritable
themewritable
dark · hc · light

Example response

{
  "bayMenuPosition": "top",
  "confirmConfigApply": true,
  "density": "auto",
  "dismissedMissingKey": "",
  "eqFillMode": "summed",
  "eqTap": "both",
  "hideUnpatched": false,
  "narrowOnOverflow": false,
  "occupiedPatch": "warn",
  "panelTap": "both",
  "processingPanel": {},
  "sendBus": null,
  "theme": "dark"
}

Selection

GETPATCH/surface/selection

channelwritable

Example response

{
  "channel": {
    "index": 1,
    "kind": "input"
  }
}

Touch

GETPATCH/surface/touch/{kind}/{index}

e.g. /surface/touch/input/1

touchedwritable

Example response

{
  "touched": false
}