Skip to content

HTTP APIs

Matteo Piccina edited this page May 16, 2022 · 1 revision

Compatible with v0.0.15 and later.

Default port 6565 (currently editable only in config file, not in UI)

Description Method URL
Start command. All parameters are optional, if called as /start it will start using the time set on UI GET /set/<hours>/<minutes>/<seconds>
Set the time on SET GET /start/<hours>/<minutes>/<seconds>
Pause command GET /pause
Resume command GET /resume
Toggle pause/resume command GET /toggle-pause
Reset command. If the timer is going it will reset only the time, if the timer is stopped it will reset the set time. GET /reset
Jog SET time command. Increment or decrement SET time (use negative values to decrement) GET /jog-set/<hours>/<minutes>/<seconds>
Jog CURRENT time command. Increment or decrement CURRENT time (use negative values to decrement) GET /jog-current/<hours>/<minutes>/<seconds>
WebSocket endpoint. You can receive update events of status. See below for explanation WS /ws

Clone this wiki locally