872 B
872 B
| 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 |
|
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.