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-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update REST API docs

Browse Source
This commit is contained in:
Paulus Schoutsen 2015-12-20 16:58:43 -08:00
parent d724a9c84e
commit cd539236f3
1 changed files with 31 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
source/developers/rest_api.markdown
View File

@ -212,10 +212,20 @@ Returns a state object for specified entity_id. Returns 404 if not found.
Sample `curl` command:
```$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \
```bash
$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \
http://IP_ADDRESS:8123/api/states/sensor.kitchen_temperature
```
#### {% linkable_title GET /api/error_log %}
Retrieve all errors logged during the current session of Home Assistant as a plaintext response.
```text
15-12-20 11:02:50 homeassistant.components.recorder: Found unfinished sessions
15-12-20 11:03:03 netdisco.ssdp: Error fetching description at http://192.168.1.1:8200/rootDesc.xml
15-12-20 11:04:36 homeassistant.components.alexa: Received unknown intent HelpIntent
```
#### {% linkable_title POST /api/states/<entity_id> %}
Updates or creates the current state of an entity.
@ -317,6 +327,21 @@ $ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \
The result will include any changed states that changed while the service was being executed, even if their change was the result of something else happening in the system.
</p>
#### {% linkable_title POST /api/template %}
Render a Home Assistant template. [See template docs for more information.](/getting-started/templating/)
```json
{
"template": "Paulus is at {% raw %}{{ states('device_tracker.paulus') }}{% endraw %}!"
}
```
Returns the rendered template in plain text.
```text
Paulus is at work!
```
#### {% linkable_title POST /api/event_forwarding %}
Setup event forwarding to another Home Assistant instance.