397 lines
No EOL
21 KiB
HTML
397 lines
No EOL
21 KiB
HTML
<!doctype html>
|
|
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
|
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
|
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
|
|
|
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Rest API - Home Assistant</title>
|
|
<meta name="author" content="Paulus Schoutsen">
|
|
|
|
<meta name="description" content="Home Assistant is an open-source home automation platform running on Python 3.">
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io">
|
|
|
|
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
|
|
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
|
<link rel='shortcut icon' href='/images/favicon.ico' />
|
|
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
|
</head>
|
|
|
|
|
|
<body >
|
|
|
|
<header>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
|
|
<div class="grid__item three-tenths lap-four-sixths palm-one-whole ha-title">
|
|
<a href="/" class="site-title">
|
|
<img width='40' src='/images/favicon-192x192.png'> Home Assistant
|
|
</a>
|
|
</div>
|
|
|
|
<div class="grid__item seven-tenths lap-two-sixths palm-one-whole">
|
|
<nav>
|
|
<input type="checkbox" id="toggle">
|
|
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
|
<ul class="menu pull-right">
|
|
<li><a href="/getting-started/">Getting started</a></li>
|
|
<li><a href="/architecture/">Architecture</a></li>
|
|
<li><a href="/developers/">Developers</a></li>
|
|
<li><a href="/api/">API</a></li>
|
|
<li><a href="/blog/">Blog</a></li>
|
|
<li><a href="https://groups.google.com/forum/#!forum/home-assistant-dev">Need help?</a></li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</header>
|
|
|
|
|
|
|
|
<div class="grid-wrapper">
|
|
<div class="grid grid-center">
|
|
|
|
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
|
|
|
|
|
<article class="page">
|
|
|
|
|
|
<header>
|
|
<h1 class="title indent">
|
|
Rest API
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
|
|
|
|
<p>Home Assistent runs a webserver accessible on port 8123.</p>
|
|
|
|
<ul>
|
|
<li><a href="http://127.0.0.1:8123/">http://127.0.0.1:8123/</a> is an interface to control Home Assistant.</li>
|
|
<li><a href="http://localhost:8123/api/">http://localhost:8123/api/</a> is a Rest API.</li>
|
|
</ul>
|
|
|
|
|
|
<p>In the package <a href="https://github.com/balloob/home-assistant/blob/master/homeassistant/remote.py"><code>homeassistant.remote</code></a> a Python API on top of the HTTP API can be found.</p>
|
|
|
|
<p>The API accepts and returns only JSON encoded objects. All API calls have to be accompanied by the header <code>X-HA-Access: YOUR_PASSWORD</code> (as specified in your <code>home-assistant.conf</code>).</p>
|
|
|
|
<div class='note'><p class='title'>Note</p><p class='content'>
|
|
You can append <code>?api_password=YOUR_PASSWORD</code> to any url to log in automatically.
|
|
</p></div>
|
|
|
|
|
|
<p>Successful calls will return status code 200 or 201. Other status codes that can return are:</p>
|
|
|
|
<ul>
|
|
<li>400 (Bad Request)</li>
|
|
<li>401 (Unauthorized)</li>
|
|
<li>404 (Not Found)</li>
|
|
<li>405 (Method not allowed)</li>
|
|
</ul>
|
|
|
|
|
|
<p>The api supports the following actions:</p>
|
|
|
|
<p><strong>/api - GET</strong><br>
|
|
Returns message if API is up and running.</p>
|
|
|
|
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
|
|
<span class='line-number'>2</span>
|
|
<span class='line-number'>3</span>
|
|
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"message"</span><span class="p">:</span> <span class="s2">"API running."</span>
|
|
</span><span class='line'><span class="p">}</span>
|
|
</span></code></pre></td></tr></table></div></figure>
|
|
|
|
|
|
<p><strong>/api/events - GET</strong><br>
|
|
Returns an array of event objects. Each event object contain event name and listener count.</p>
|
|
|
|
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
|
|
<span class='line-number'>2</span>
|
|
<span class='line-number'>3</span>
|
|
<span class='line-number'>4</span>
|
|
<span class='line-number'>5</span>
|
|
<span class='line-number'>6</span>
|
|
<span class='line-number'>7</span>
|
|
<span class='line-number'>8</span>
|
|
<span class='line-number'>9</span>
|
|
<span class='line-number'>10</span>
|
|
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">[</span>
|
|
</span><span class='line'> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"event"</span><span class="p">:</span> <span class="s2">"state_changed"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"listener_count"</span><span class="p">:</span> <span class="mi">5</span>
|
|
</span><span class='line'> <span class="p">},</span>
|
|
</span><span class='line'> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"event"</span><span class="p">:</span> <span class="s2">"time_changed"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"listener_count"</span><span class="p">:</span> <span class="mi">2</span>
|
|
</span><span class='line'> <span class="p">}</span>
|
|
</span><span class='line'><span class="p">]</span>
|
|
</span></code></pre></td></tr></table></div></figure>
|
|
|
|
|
|
<p><strong>/api/services - GET</strong><br>
|
|
Returns an array of service objects. Each object contains the domain and which services it contains.</p>
|
|
|
|
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
|
|
<span class='line-number'>2</span>
|
|
<span class='line-number'>3</span>
|
|
<span class='line-number'>4</span>
|
|
<span class='line-number'>5</span>
|
|
<span class='line-number'>6</span>
|
|
<span class='line-number'>7</span>
|
|
<span class='line-number'>8</span>
|
|
<span class='line-number'>9</span>
|
|
<span class='line-number'>10</span>
|
|
<span class='line-number'>11</span>
|
|
<span class='line-number'>12</span>
|
|
<span class='line-number'>13</span>
|
|
<span class='line-number'>14</span>
|
|
<span class='line-number'>15</span>
|
|
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">[</span>
|
|
</span><span class='line'> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"domain"</span><span class="p">:</span> <span class="s2">"browser"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"services"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span><span class='line'> <span class="s2">"browse_url"</span>
|
|
</span><span class='line'> <span class="p">]</span>
|
|
</span><span class='line'> <span class="p">},</span>
|
|
</span><span class='line'> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"domain"</span><span class="p">:</span> <span class="s2">"keyboard"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"services"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span><span class='line'> <span class="s2">"volume_up"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="s2">"volume_down"</span>
|
|
</span><span class='line'> <span class="p">]</span>
|
|
</span><span class='line'> <span class="p">}</span>
|
|
</span><span class='line'><span class="p">]</span>
|
|
</span></code></pre></td></tr></table></div></figure>
|
|
|
|
|
|
<p><strong>/api/states - GET</strong><br>
|
|
Returns an array of state objects. Each state has the following attributes: entity_id, state, last_changed and attributes.</p>
|
|
|
|
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
|
|
<span class='line-number'>2</span>
|
|
<span class='line-number'>3</span>
|
|
<span class='line-number'>4</span>
|
|
<span class='line-number'>5</span>
|
|
<span class='line-number'>6</span>
|
|
<span class='line-number'>7</span>
|
|
<span class='line-number'>8</span>
|
|
<span class='line-number'>9</span>
|
|
<span class='line-number'>10</span>
|
|
<span class='line-number'>11</span>
|
|
<span class='line-number'>12</span>
|
|
<span class='line-number'>13</span>
|
|
<span class='line-number'>14</span>
|
|
<span class='line-number'>15</span>
|
|
<span class='line-number'>16</span>
|
|
<span class='line-number'>17</span>
|
|
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">[</span>
|
|
</span><span class='line'> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"attributes"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"next_rising"</span><span class="p">:</span> <span class="s2">"07:04:15 29-10-2013"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"next_setting"</span><span class="p">:</span> <span class="s2">"18:00:31 29-10-2013"</span>
|
|
</span><span class='line'> <span class="p">},</span>
|
|
</span><span class='line'> <span class="nt">"entity_id"</span><span class="p">:</span> <span class="s2">"sun.sun"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"last_changed"</span><span class="p">:</span> <span class="s2">"23:24:33 28-10-2013"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"state"</span><span class="p">:</span> <span class="s2">"below_horizon"</span>
|
|
</span><span class='line'> <span class="p">},</span>
|
|
</span><span class='line'> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"attributes"</span><span class="p">:</span> <span class="p">{},</span>
|
|
</span><span class='line'> <span class="nt">"entity_id"</span><span class="p">:</span> <span class="s2">"process.Dropbox"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"last_changed"</span><span class="p">:</span> <span class="s2">"23:24:33 28-10-2013"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"state"</span><span class="p">:</span> <span class="s2">"on"</span>
|
|
</span><span class='line'> <span class="p">}</span>
|
|
</span><span class='line'><span class="p">]</span>
|
|
</span></code></pre></td></tr></table></div></figure>
|
|
|
|
|
|
<p><strong>/api/states/<entity_id></strong> - GET<br>
|
|
Returns a state object for specified entity_id. Returns 404 if not found.</p>
|
|
|
|
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
|
|
<span class='line-number'>2</span>
|
|
<span class='line-number'>3</span>
|
|
<span class='line-number'>4</span>
|
|
<span class='line-number'>5</span>
|
|
<span class='line-number'>6</span>
|
|
<span class='line-number'>7</span>
|
|
<span class='line-number'>8</span>
|
|
<span class='line-number'>9</span>
|
|
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"attributes"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"next_rising"</span><span class="p">:</span> <span class="s2">"07:04:15 29-10-2013"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"next_setting"</span><span class="p">:</span> <span class="s2">"18:00:31 29-10-2013"</span>
|
|
</span><span class='line'> <span class="p">},</span>
|
|
</span><span class='line'> <span class="nt">"entity_id"</span><span class="p">:</span> <span class="s2">"sun.sun"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"last_changed"</span><span class="p">:</span> <span class="s2">"23:24:33 28-10-2013"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"state"</span><span class="p">:</span> <span class="s2">"below_horizon"</span>
|
|
</span><span class='line'><span class="p">}</span>
|
|
</span></code></pre></td></tr></table></div></figure>
|
|
|
|
|
|
<p><strong>/api/states/<entity_id></strong> - POST<br>
|
|
Updates or creates the current state of an entity.</p>
|
|
|
|
<p>Return code is 200 if the entity existed, 201 if the state of a new entity was set. A location header will be returned with the url of the new resource. The response body will contain a JSON encoded State object.<br>
|
|
<br>
|
|
parameter: state - string<br>
|
|
optional parameter: attributes - JSON object</p>
|
|
|
|
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
|
|
<span class='line-number'>2</span>
|
|
<span class='line-number'>3</span>
|
|
<span class='line-number'>4</span>
|
|
<span class='line-number'>5</span>
|
|
<span class='line-number'>6</span>
|
|
<span class='line-number'>7</span>
|
|
<span class='line-number'>8</span>
|
|
<span class='line-number'>9</span>
|
|
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"attributes"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"next_rising"</span><span class="p">:</span> <span class="s2">"07:04:15 29-10-2013"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"next_setting"</span><span class="p">:</span> <span class="s2">"18:00:31 29-10-2013"</span>
|
|
</span><span class='line'> <span class="p">},</span>
|
|
</span><span class='line'> <span class="nt">"entity_id"</span><span class="p">:</span> <span class="s2">"weather.sun"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"last_changed"</span><span class="p">:</span> <span class="s2">"23:24:33 28-10-2013"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"state"</span><span class="p">:</span> <span class="s2">"below_horizon"</span>
|
|
</span><span class='line'><span class="p">}</span>
|
|
</span></code></pre></td></tr></table></div></figure>
|
|
|
|
|
|
<p><strong>/api/events/<event_type></strong> - POST<br>
|
|
Fires an event with event_type<br>
|
|
optional body: JSON encoded object that represents event_data</p>
|
|
|
|
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
|
|
<span class='line-number'>2</span>
|
|
<span class='line-number'>3</span>
|
|
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"message"</span><span class="p">:</span> <span class="s2">"Event download_file fired."</span>
|
|
</span><span class='line'><span class="p">}</span>
|
|
</span></code></pre></td></tr></table></div></figure>
|
|
|
|
|
|
<p><strong>/api/services/<domain>/<service></strong> - POST<br>
|
|
Calls a service within a specific domain. Will return when the service has been executed or 10 seconds has past, whichever comes first.<br>
|
|
optional body: JSON encoded object that represents service_data</p>
|
|
|
|
<p>Returns a list of states that have changed since the start of this service call.</p>
|
|
|
|
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
|
|
<span class='line-number'>2</span>
|
|
<span class='line-number'>3</span>
|
|
<span class='line-number'>4</span>
|
|
<span class='line-number'>5</span>
|
|
<span class='line-number'>6</span>
|
|
<span class='line-number'>7</span>
|
|
<span class='line-number'>8</span>
|
|
<span class='line-number'>9</span>
|
|
<span class='line-number'>10</span>
|
|
<span class='line-number'>11</span>
|
|
<span class='line-number'>12</span>
|
|
<span class='line-number'>13</span>
|
|
<span class='line-number'>14</span>
|
|
<span class='line-number'>15</span>
|
|
<span class='line-number'>16</span>
|
|
<span class='line-number'>17</span>
|
|
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">[</span>
|
|
</span><span class='line'> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"attributes"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"next_rising"</span><span class="p">:</span> <span class="s2">"07:04:15 29-10-2013"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"next_setting"</span><span class="p">:</span> <span class="s2">"18:00:31 29-10-2013"</span>
|
|
</span><span class='line'> <span class="p">},</span>
|
|
</span><span class='line'> <span class="nt">"entity_id"</span><span class="p">:</span> <span class="s2">"sun.sun"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"last_changed"</span><span class="p">:</span> <span class="s2">"23:24:33 28-10-2013"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"state"</span><span class="p">:</span> <span class="s2">"below_horizon"</span>
|
|
</span><span class='line'> <span class="p">},</span>
|
|
</span><span class='line'> <span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"attributes"</span><span class="p">:</span> <span class="p">{},</span>
|
|
</span><span class='line'> <span class="nt">"entity_id"</span><span class="p">:</span> <span class="s2">"process.Dropbox"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"last_changed"</span><span class="p">:</span> <span class="s2">"23:24:33 28-10-2013"</span><span class="p">,</span>
|
|
</span><span class='line'> <span class="nt">"state"</span><span class="p">:</span> <span class="s2">"on"</span>
|
|
</span><span class='line'> <span class="p">}</span>
|
|
</span><span class='line'><span class="p">]</span>
|
|
</span></code></pre></td></tr></table></div></figure>
|
|
|
|
|
|
<p><strong>/api/event_forwarding</strong> - POST<br>
|
|
Setup event forwarding to another Home Assistant instance.<br>
|
|
parameter: host - string<br>
|
|
parameter: api_password - string<br>
|
|
optional parameter: port - int<br></p>
|
|
|
|
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
|
|
<span class='line-number'>2</span>
|
|
<span class='line-number'>3</span>
|
|
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"message"</span><span class="p">:</span> <span class="s2">"Event forwarding setup."</span>
|
|
</span><span class='line'><span class="p">}</span>
|
|
</span></code></pre></td></tr></table></div></figure>
|
|
|
|
|
|
<p><strong>/api/event_forwarding</strong> - DELETE<br>
|
|
Cancel event forwarding to another Home Assistant instance.<br>
|
|
parameter: host - string<br>
|
|
optional parameter: port - int<br></p>
|
|
|
|
<p>If your client does not support DELETE HTTP requests you can add an optional attribute _METHOD and set its value to DELETE.</p>
|
|
|
|
<figure class='code'><figcaption><span></span></figcaption><div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers"><span class='line-number'>1</span>
|
|
<span class='line-number'>2</span>
|
|
<span class='line-number'>3</span>
|
|
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">{</span>
|
|
</span><span class='line'> <span class="nt">"message"</span><span class="p">:</span> <span class="s2">"Event forwarding cancelled."</span>
|
|
</span><span class='line'><span class="p">}</span>
|
|
</span></code></pre></td></tr></table></div></figure>
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
<div class="grid__item">
|
|
<p class="copyright">
|
|
<span class="credit">Site powered by <a href="http://octopress.org">Octopress</a>, <a href='http://jekyllrb.com/'>Jekyll</a> and using the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.</span>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</footer>
|
|
|
|
<!--[if lt IE 7]>
|
|
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
|
|
<![endif]-->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |