mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-08 20:18:59 +00:00
dbd192a057
Corrected spelling of "Assistant" in the title of the page. My first direct, if meaningless, contribution to the Home Assistant project
39 lines
1.1 KiB
Markdown
39 lines
1.1 KiB
Markdown
---
|
|
title: Home Assistant WebSocket API
|
|
description: Instructions on how to setup the WebSocket API within Home Assistant.
|
|
ha_category:
|
|
- Other
|
|
ha_release: 0.34
|
|
ha_quality_scale: internal
|
|
ha_codeowners:
|
|
- '@home-assistant/core'
|
|
ha_domain: websocket_api
|
|
---
|
|
|
|
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](/integrations/http/).
|
|
|
|
<div 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.
|
|
|
|
</div>
|
|
|
|
## Configuration
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
websocket_api:
|
|
```
|
|
|
|
For details to use the WebSocket API, please refer to the [WebSocket API documentation](/developers/websocket_api/) .
|
|
|
|
## 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:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
platform: websocket_api
|
|
```
|