jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-10-29 00:07:46 UTC

Browse source
This commit is contained in:
Travis CI 2017-10-29 00:07:47 +00:00
parent 065116d821
commit 17b5b61441
31 changed files with 161 additions and 109 deletions
Download patch file Download diff file Expand all files Collapse all files

70
developers/rest_api/index.html
View file

@ -99,7 +99,7 @@
</code></pre>
</div>
<p class="note">
You can append <code class="highlighter-rouge">?api_password=YOUR_PASSWORD</code> to any url to log in automatically.
You can append <code class="highlighter-rouge">?api_password=YOUR_PASSWORD</code> to any URL to log in automatically.
</p>
<p>Successful calls will return status code 200 or 201. Other status codes that can return are:</p>
<ul>
@ -124,33 +124,43 @@ You can append <code class="highlighter-rouge">?api_password=YOUR_PASSWORD</code
</div>
<h4><a class="title-link" name="get-apiconfig" href="#get-apiconfig"></a> GET /api/config</h4>
<p>Returns the current configuration as JSON.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"components"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="s2">"recorder"</span><span class="p">,</span><span class="w">
</span><span class="s2">"http"</span><span class="p">,</span><span class="w">
</span><span class="s2">"weather.openweathermap"</span><span class="p">,</span><span class="w">
</span><span class="s2">"api"</span><span class="p">,</span><span class="w">
</span><span class="s2">"websocket_api"</span><span class="p">,</span><span class="w">
</span><span class="s2">"frontend"</span><span class="p">,</span><span class="w">
</span><span class="s2">"sensor.time_date"</span><span class="p">,</span><span class="w">
</span><span class="s2">"sun"</span><span class="p">,</span><span class="w">
</span><span class="s2">"device_tracker"</span><span class="p">,</span><span class="w">
</span><span class="s2">"group"</span><span class="p">,</span><span class="w">
</span><span class="s2">"automation"</span><span class="w">
</span><span class="p">],</span><span class="w">
</span><span class="nt">"config_dir"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/home/ha/.homeassistant"</span><span class="p">,</span><span class="w">
</span><span class="nt">"elevation"</span><span class="p">:</span><span class="w"> </span><span class="mi">590</span><span class="p">,</span><span class="w">
</span><span class="nt">"latitude"</span><span class="p">:</span><span class="w"> </span><span class="mf">45.92</span><span class="p">,</span><span class="w">
</span><span class="nt">"location_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Home"</span><span class="p">,</span><span class="w">
</span><span class="nt">"longitude"</span><span class="p">:</span><span class="w"> </span><span class="mf">6.52</span><span class="p">,</span><span class="w">
</span><span class="nt">"time_zone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Europe/Zurich"</span><span class="p">,</span><span class="w">
</span><span class="nt">"unit_system"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nt">"length"</span><span class="p">:</span><span class="w"> </span><span class="s2">"km"</span><span class="p">,</span><span class="w">
</span><span class="nt">"mass"</span><span class="p">:</span><span class="w"> </span><span class="s2">"g"</span><span class="p">,</span><span class="w">
</span><span class="nt">"temperature"</span><span class="p">:</span><span class="w"> </span><span class="s2">"\\u00b0C"</span><span class="p">,</span><span class="w">
</span><span class="nt">"volume"</span><span class="p">:</span><span class="w"> </span><span class="s2">"L"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.37.0.dev0"</span><span class="w">
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"components"</span><span class="p">:[</span><span class="w">
</span><span class="s2">"sensor.cpuspeed"</span><span class="p">,</span><span class="w">
</span><span class="s2">"frontend"</span><span class="p">,</span><span class="w">
</span><span class="s2">"config.core"</span><span class="p">,</span><span class="w">
</span><span class="s2">"http"</span><span class="p">,</span><span class="w">
</span><span class="s2">"map"</span><span class="p">,</span><span class="w">
</span><span class="s2">"api"</span><span class="p">,</span><span class="w">
</span><span class="s2">"sun"</span><span class="p">,</span><span class="w">
</span><span class="s2">"config"</span><span class="p">,</span><span class="w">
</span><span class="s2">"discovery"</span><span class="p">,</span><span class="w">
</span><span class="s2">"conversation"</span><span class="p">,</span><span class="w">
</span><span class="s2">"recorder"</span><span class="p">,</span><span class="w">
</span><span class="s2">"group"</span><span class="p">,</span><span class="w">
</span><span class="s2">"sensor"</span><span class="p">,</span><span class="w">
</span><span class="s2">"websocket_api"</span><span class="p">,</span><span class="w">
</span><span class="s2">"automation"</span><span class="p">,</span><span class="w">
</span><span class="s2">"config.automation"</span><span class="p">,</span><span class="w">
</span><span class="s2">"config.customize"</span><span class="w">
</span><span class="p">],</span><span class="w">
</span><span class="nt">"config_dir"</span><span class="p">:</span><span class="s2">"/home/ha/.homeassistant"</span><span class="p">,</span><span class="w">
</span><span class="nt">"elevation"</span><span class="p">:</span><span class="mi">510</span><span class="p">,</span><span class="w">
</span><span class="nt">"latitude"</span><span class="p">:</span><span class="mf">45.8781529</span><span class="p">,</span><span class="w">
</span><span class="nt">"location_name"</span><span class="p">:</span><span class="s2">"Home"</span><span class="p">,</span><span class="w">
</span><span class="nt">"longitude"</span><span class="p">:</span><span class="mf">8.458853651</span><span class="p">,</span><span class="w">
</span><span class="nt">"time_zone"</span><span class="p">:</span><span class="s2">"Europe/Zurich"</span><span class="p">,</span><span class="w">
</span><span class="nt">"unit_system"</span><span class="p">:{</span><span class="w">
</span><span class="nt">"length"</span><span class="p">:</span><span class="s2">"km"</span><span class="p">,</span><span class="w">
</span><span class="nt">"mass"</span><span class="p">:</span><span class="s2">"g"</span><span class="p">,</span><span class="w">
</span><span class="nt">"temperature"</span><span class="p">:</span><span class="s2">"\u00b0C"</span><span class="p">,</span><span class="w">
</span><span class="nt">"volume"</span><span class="p">:</span><span class="s2">"L"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nt">"version"</span><span class="p">:</span><span class="s2">"0.56.2"</span><span class="p">,</span><span class="w">
</span><span class="nt">"whitelist_external_dirs"</span><span class="p">:[</span><span class="w">
</span><span class="s2">"/home/ha/.homeassistant/www"</span><span class="p">,</span><span class="w">
</span><span class="s2">"/home/ha/.homeassistant/"</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>
@ -162,10 +172,10 @@ You can append <code class="highlighter-rouge">?api_password=YOUR_PASSWORD</code
<h4><a class="title-link" name="get-apidiscovery_info" href="#get-apidiscovery_info"></a> GET /api/discovery_info</h4>
<p>Returns basic information about the Home Assistant instance as JSON.</p>
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"base_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://127.0.0.1:8123"</span><span class="p">,</span><span class="w">
</span><span class="nt">"base_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://192.168.0.2:8123"</span><span class="p">,</span><span class="w">
</span><span class="nt">"location_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Home"</span><span class="p">,</span><span class="w">
</span><span class="nt">"requires_api_password"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nt">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.20.0.dev0"</span><span class="w">
</span><span class="nt">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.56.2"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre>
</div>