mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-06 19:18:59 +00:00
7eace6c371
* Various small fixes Add configuration and other titles Remove empty lines Fix indentation for configuration block Reorder key list to be in line with the rest Delete empty default value and fixed value type * None is a valid value
27 lines
854 B
Markdown
27 lines
854 B
Markdown
---
|
|
layout: page
|
|
title: "API"
|
|
description: "Instructions on how to setup the RESTful 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"
|
|
ha_qa_scale: internal
|
|
---
|
|
|
|
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](/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
|
|
api:
|
|
```
|
|
|
|
For details to use the API, please refer to the [REST API](/developers/rest_api/) or the [Python REST API documentation](/developers/python_api/) in the "Developer" section.
|