Jump to Content
API Reference
v1.0
v2.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
ESPHome
API Reference
Toggle the Learn Mode
Search
JUMP TO
Getting Started
Introduction
Server-sent Events
Made for ESPHome
GDO blaQ REST API
GDO blaQ Introduction
/cover/garage_door
Garage Door State
get
/cover/garage_door/open
Open Command
post
/cover/garage_door/close
Close Command
post
/cover/garage_door/stop
Stop Command
post
/cover/garage_door/toggle
Toggle Command
post
/cover/garage_door/set
Set Position Command
post
/light/garage_light
Garage Light State
get
/light/garage_light/turn_on
Turn on the Garage Light
post
/light/garage_light/turn_off
Turn off the Garage Light
post
/light/garage_light/toggle
Toggle the Garage Light
post
/lock/lock
Garage Remote Control Lock State
get
/lock/lock/lock
Lock the Remote Control Lock
post
/lock/lock/unlock
Unlock the Remote Control Lock
post
/binary_sensor/motion
Motion Sensor State
get
/binary_sensor/synced
Protocol Sync State
get
/binary_sensor/obstruction
Obstruction (safety beam) state
get
/binary_sensor/motor
Garage opener motor state
get
/binary_sensor/wall_button
Wall Button State
get
/sensor/garage_openings
Cumulative opening cycles of the garage motor
get
/select/security__protocol
Get the selected/detected Security+ protocol setting of the GDO blaQ
get
/select/security__protocol/set
Set the Security+ protocol
post
/switch/learn
State of the "learn mode" on the opener
get
/switch/learn/turn_on
Turn on Learn Mode
post
/switch/learn/turn_off
Turn off Learn Mode
post
/switch/learn/toggle
Toggle the Learn Mode
post
/sensor/wifi_signal_rssi
Wi-Fi signal strength RSSI
get
/sensor/wifi_signal__
Wi-Fi signal strength %
get
/sensor/uptime
Uptime
get
/text_sensor/device_id
Device ID
get
/text_sensor/ip_address
IP Address
get
/button/pre_close_warning/press
Trigger the pre-close warning
post
/button/play_sound/press
Plays the pre-configured pre-close warning sound
post
/button/restart/press
Restart/reboot the device
post
/button/factory_reset/press
Reset with Factory Default Settings
post
GDO White REST API
GDO White Introduction
/cover/garage_door
Garage Door State
get
/cover/garage_door/open
Open Command
post
/cover/garage_door/close
Close Command
post
/cover/garage_door/stop
Stop Command
post
/cover/garage_door/toggle
Toggle Command
post
/binary_sensor/wired_sensor
Wired Input State
get
/switch/str_output
STR Output State
get
/switch/str_output/turn_on
Turn on STR Output
post
/switch/str_output/turn_off
Turn off STR Output
post
/switch/str_output/toggle
Toggle the STR Output
post
/binary_sensor/garage_door_range_sensor
Garage Door State determined by optical laser sensor
get
/number/sensor_calibration
Calibrated distance of the open garage door
get
/number/sensor_calibration/set
Set calibrated distance of the open garage door
post
/sensor/sensor_distance
Distance measurement of the optical laser sensor
get
/sensor/wifi_signal_rssi
Wi-Fi signal strength RSSI
get
/sensor/wifi_signal__
Wi-Fi signal strength %
get
/sensor/uptime
Uptime
get
/text_sensor/device_id
Device ID
get
/text_sensor/ip_address
IP Address
get
/button/pre_close_warning/press
Trigger the pre-close warning
post
/button/play_sound/press
Plays the pre-configured pre-close warning sound
post
/button/garage_door_opener_button/press
Trigger the garage door opener button
post
/button/restart/press
Restart/reboot the device
post
/button/factory_reset/press
Reset with Factory Default Settings
post
Alarm Panel REST API
/alarm_control_panel/{name}
Alarm System state
get
/alarm_control_panel/{name}/{method}
Arm or disarm the alarm system
post
/binary_sensor/{zone}
Zone state
get
/switch/{output}
Output state
get
/switch/{output}/turn_on
Turn on an output
post
/switch/{output}/turn_off
Turn off an output
post
/switch/{output}/toggle
Toggle an output
post
/light/warning_beep
Warning Beep
get
/light/warning_beep/turn_on
Turn on the warning beep
post
/light/warning_beep/turn_off
Turn off the warning beep
post
/sensor/wifi_signal_rssi
Wi-Fi signal strength RSSI
get
/sensor/wifi_signal__
Wi-Fi signal strength %
get
/sensor/uptime
Uptime
get
/button/restart/press
Restart/reboot the device
post
/text_sensor/device_id
Device ID
get
/text_sensor/ip_address
IP Address
get
Konnected Cloud REST API
/devices
Devices Index
get
/devices/{device_id}/builds/{version}
Update Build Config
put
Powered by
Toggle the Learn Mode
post
http://{localIP}/switch/learn/toggle
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
http://
localIP
/switch/learn/toggle
RESPONSE
Click
Try It!
to start a request and see the response here!