mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-03 17:48:59 +00:00
1aca7b08cf
* e.g. to e.g., and proper case for Home Assistant * Instructions how to -> Instructions on how to
26 lines
810 B
Markdown
26 lines
810 B
Markdown
---
|
|
layout: page
|
|
title: "Websocket API"
|
|
description: "Instructions on how to setup the WebSocket API within Home Assistant."
|
|
date: 2018-01-21 08:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: home-assistant.png
|
|
ha_category: "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](/components/http/).
|
|
|
|
<p class='note warning'>
|
|
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
|
|
</p>
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
websocket_api:
|
|
```
|
|
|
|
For details to use the WebSocket API, please refer to the [WebSocket API documentation](/developers/websocket_api/) .
|