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 09:17:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_components/api.markdown
Robbie Trencheny 8714fc55a2
Add ha_release to components/platforms missing it
2019-03-09 17:27:44 -08:00

870 B
Raw Blame History

layout title description date sidebar comments sharing footer logo ha_category ha_qa_scale ha_release
page API Instructions on how to setup the RESTful API within Home Assistant. 2018-01-21 08:00 true false true true home-assistant.png Other internal 0.7

The api component exposes a RESTful 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
api:

For details to use the API, please refer to the REST API or the Python REST API documentation in the "Developer" section.