mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-04-27 06:47:34 +00:00
831 B
831 B
layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_qa_scale |
---|---|---|---|---|---|---|---|---|---|---|
page | Websocket API | Instructions on how to setup the WebSocket API within Home Assistant. | 2018-01-21 08:00 | true | false | true | true | home-assistant.png | Other | internal |
The websocket_api
component set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This component 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.
# Example configuration.yaml entry
websocket_api:
For details to use the WebSocket API, please refer to the WebSocket API documentation .