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-07-28 03:37:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

rename api to rest_api

Browse Source
This commit is contained in:
Fabian Affolter 2015-05-11 11:59:18 +02:00
parent 604fee3fdc
commit ad919ed466
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
source/developers/api.markdown → source/developers/rest_api.markdown
View File

@ -14,11 +14,9 @@ Home Assistant runs a web server accessible on port 8123.
* http://127.0.0.1:8123/ is an interface to control Home Assistant. * http://127.0.0.1:8123/ is an interface to control Home Assistant.
* http://localhost:8123/api/ is a Rest API. * http://localhost:8123/api/ is a Rest API.
In the package [`homeassistant.remote`](https://github.com/balloob/home-assistant/blob/master/homeassistant/remote.py) a Python API on top of the HTTP API can be found. The API accepts and returns only JSON encoded objects. All API calls have to be accompanied by the header `X-HA-Access: YOUR_PASSWORD` (YOUR_PASSWORD as specified in your `configuration.yaml` file).
The API accepts and returns only JSON encoded objects. All API calls have to be accompanied by the header `X-HA-Access: YOUR_PASSWORD` (YOUR_PASSWORD as specified in your `configuration.yaml`). There are multiple ways to consume the Home Assistant Rest API. One is with `curl`:
There are several ways to consume the Home Assistant API. One is with `curl`:
```bash ```bash
curl -X GET \ curl -X GET \
@ -36,7 +34,6 @@ headers = {'x-ha-access': 'YOUR_PASSWORD',
'content-type': 'application/json'} 'content-type': 'application/json'}
response = get(url, headers=headers) response = get(url, headers=headers)
print(response.text) print(response.text)
``` ```
@ -51,7 +48,9 @@ Successful calls will return status code 200 or 201. Other status codes that can
- 404 (Not Found) - 404 (Not Found)
- 405 (Method not allowed) - 405 (Method not allowed)
The api supports the following actions: ### {% linkable_title Actions %}
The API supports the following actions:
#### {% linkable_title GET /api %} #### {% linkable_title GET /api %}
Returns message if API is up and running. Returns message if API is up and running.