mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-04-27 06:47:34 +00:00
1833c32a2c
* Sets front matter defaults * Removes default front matter from section templates/pages * Removes default front matter from addon pages * Removes default front matter from integration pages * Removes default front matter from posts * Removes default front matter from docs pages * Removes default front matter from other pages * Fixes blog category pages
1.0 KiB
1.0 KiB
| title | description | logo | ha_category | ha_qa_scale | ha_release | |
|---|---|---|---|---|---|---|
| Websocket API | Instructions on how to setup the WebSocket API within Home Assistant. | home-assistant.png |
|
internal | 0.34 |
The websocket_api integration set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the http component.
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
Configuration
# Example configuration.yaml entry
websocket_api:
For details to use the WebSocket API, please refer to the WebSocket API documentation .
Track current connections
The websocket API provides a sensor that will keep track of the number of current connected clients. You can add it by adding the following to your configuration:
# Example configuration.yaml entry
sensor:
platform: websocket_api