home-assistant.io/source/_components/websocket_api.markdown
Alok Saboo 1aca7b08cf Misc fixes: e.g. -> e.g., and proper case for Home Assistant (#4942)
* e.g. to e.g., and proper case for Home Assistant

* Instructions how to -> Instructions on how to
2018-03-17 20:20:37 +01:00

810 B

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

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 .