jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-02 17:18:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_components/websocket_api.markdown
Jorim Tielemans c0d8b1fbf0 Clean up wxz (#7025) 
Titles
Trailing spaces
Boolean capitalization
2018-10-23 11:08:53 +02:00

870 B
Raw Blame History

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_qa_scale
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.

{% linkable_title Configuration %}

# Example configuration.yaml entry
websocket_api:

For details to use the WebSocket API, please refer to the WebSocket API documentation .