Jump to Content

API Reference

Getting Started

Introduction
Server-sent Events
Made for ESPHome

GDO blaQ REST API

GDO blaQ Introduction
/cover/garage_door
- Garage Door Stateget
/cover/garage_door/open
- Open Commandpost
/cover/garage_door/close
- Close Commandpost
/cover/garage_door/stop
- Stop Commandpost
/cover/garage_door/toggle
- Toggle Commandpost
/cover/garage_door/set
- Set Position Commandpost
/light/garage_light
- Garage Light Stateget
/light/garage_light/turn_on
- Turn on the Garage Lightpost
/light/garage_light/turn_off
- Turn off the Garage Lightpost
/light/garage_light/toggle
- Toggle the Garage Lightpost
/lock/lock
- Garage Remote Control Lock Stateget
/lock/lock/lock
- Lock the Remote Control Lockpost
/lock/lock/unlock
- Unlock the Remote Control Lockpost
/binary_sensor/motion
- Motion Sensor Stateget
/binary_sensor/synced
- Protocol Sync Stateget
/binary_sensor/obstruction
- Obstruction (safety beam) stateget
/binary_sensor/motor
- Garage opener motor stateget
/binary_sensor/wall_button
- Wall Button Stateget
/sensor/garage_openings
- Cumulative opening cycles of the garage motorget
/select/security__protocol
- Get the selected/detected Security+ protocol setting of the GDO blaQget
/select/security__protocol/set
- Set the Security+ protocolpost
/switch/learn
- State of the "learn mode" on the openerget
/switch/learn/turn_on
- Turn on Learn Modepost
/switch/learn/turn_off
- Turn off Learn Modepost
/switch/learn/toggle
- Toggle the Learn Modepost
/sensor/wifi_signal_rssi
- Wi-Fi signal strength RSSIget
/sensor/wifi_signal__
- Wi-Fi signal strength %get
/sensor/uptime
- Uptimeget
/text_sensor/device_id
- Device IDget
/text_sensor/ip_address
- IP Addressget
/button/pre_close_warning/press
- Trigger the pre-close warningpost
/button/play_sound/press
- Plays the pre-configured pre-close warning soundpost
/button/restart/press
- Restart/reboot the devicepost
/button/factory_reset/press
- Reset with Factory Default Settingspost

GDO White REST API

GDO White Introduction
/cover/garage_door
- Garage Door Stateget
/cover/garage_door/open
- Open Commandpost
/cover/garage_door/close
- Close Commandpost
/cover/garage_door/stop
- Stop Commandpost
/cover/garage_door/toggle
- Toggle Commandpost
/binary_sensor/wired_sensor
- Wired Input Stateget
/switch/str_output
- STR Output Stateget
/switch/str_output/turn_on
- Turn on STR Outputpost
/switch/str_output/turn_off
- Turn off STR Outputpost
/switch/str_output/toggle
- Toggle the STR Outputpost
/binary_sensor/garage_door_range_sensor
- Garage Door State determined by optical laser sensorget
/number/sensor_calibration
- Calibrated distance of the open garage doorget
/number/sensor_calibration/set
- Set calibrated distance of the open garage doorpost
/sensor/sensor_distance
- Distance measurement of the optical laser sensorget
/sensor/wifi_signal_rssi
- Wi-Fi signal strength RSSIget
/sensor/wifi_signal__
- Wi-Fi signal strength %get
/sensor/uptime
- Uptimeget
/text_sensor/device_id
- Device IDget
/text_sensor/ip_address
- IP Addressget
/button/pre_close_warning/press
- Trigger the pre-close warningpost
/button/play_sound/press
- Plays the pre-configured pre-close warning soundpost
/button/garage_door_opener_button/press
- Trigger the garage door opener buttonpost
/button/restart/press
- Restart/reboot the devicepost
/button/factory_reset/press
- Reset with Factory Default Settingspost

Alarm Panel REST API

/alarm_control_panel/{name}
- Alarm System stateget
/alarm_control_panel/{name}/{method}
- Arm or disarm the alarm systempost
/binary_sensor/{zone}
- Zone stateget
/switch/{output}
- Output stateget
/switch/{output}/turn_on
- Turn on an outputpost
/switch/{output}/turn_off
- Turn off an outputpost
/switch/{output}/toggle
- Toggle an outputpost
/light/warning_beep
- Warning Beepget
/light/warning_beep/turn_on
- Turn on the warning beeppost
/light/warning_beep/turn_off
- Turn off the warning beeppost
/sensor/wifi_signal_rssi
- Wi-Fi signal strength RSSIget
/sensor/wifi_signal__
- Wi-Fi signal strength %get
/sensor/uptime
- Uptimeget
/button/restart/press
- Restart/reboot the devicepost
/text_sensor/device_id
- Device IDget
/text_sensor/ip_address
- IP Addressget

Konnected Cloud REST API

/devices
- Devices Indexget
/devices/{device_id}/builds/{version}
- Update Build Configput

Powered by

STR Output State

get

http://{localIP}/switch/str_output

Current state of the optional STR (12V Strobe) output

Language

URL

Click Try It! to start a request and see the response here!