658 lines
No EOL
42 KiB
HTML
658 lines
No EOL
42 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>RESTful API - Home Assistant</title>
|
|
<meta name="author" content="Paulus Schoutsen">
|
|
<meta name="description" content="Home Assistant RESTful API documentation">
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/developers/rest_api/">
|
|
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="RESTful API">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/developers/rest_api/">
|
|
<meta property="og:type" content="website">
|
|
<meta property="og:description" content="Home Assistant RESTful API documentation">
|
|
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
|
|
|
<meta name="twitter:card" content="summary">
|
|
<meta name="twitter:site" content="@home_assistant">
|
|
|
|
<meta name="twitter:title" content="RESTful API">
|
|
<meta name="twitter:description" content="Home Assistant RESTful API documentation">
|
|
<meta name="twitter:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
|
|
|
<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-two-sixths palm-one-whole ha-title">
|
|
<a href="/" class="site-title">
|
|
<img width='40' src='/images/favicon-192x192.png'>
|
|
<span>Home Assistant</span>
|
|
</a>
|
|
</div>
|
|
|
|
<div class="grid__item seven-tenths lap-four-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>Getting started <i class="icon icon-caret-down"></i></a>
|
|
<ul>
|
|
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
|
|
<li><a href='/getting-started/configuration/'>Configuration basics</a></li>
|
|
<li><a href='/getting-started/devices/'>Adding devices</a></li>
|
|
<li><a href='/getting-started/presence-detection/'>Presence detection</a></li>
|
|
<li><a href='/getting-started/automation/'>Automation</a></li>
|
|
<li><a href='/getting-started/templating/'>Templating</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href='/components/'>Components</a></li>
|
|
<li><a href='/cookbook'>Examples</a></li>
|
|
<li>
|
|
<a>Developers <i class="icon icon-caret-down"></i></a>
|
|
<ul>
|
|
<li><a href="/developers/architecture/">Architecture</a></li>
|
|
<li><a href="/developers/frontend/">Frontend development</a></li>
|
|
<li><a href="/developers/creating_components/">
|
|
Creating components
|
|
</a></li>
|
|
<li><a href="/developers/add_new_platform/">
|
|
Adding platform support
|
|
</a></li>
|
|
<li><a href="/developers/api/">API</a></li>
|
|
<li><a href="/developers/credits/">Credits</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="/blog/">Blog</a></li>
|
|
<li><a href="/help/">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">
|
|
|
|
|
|
<div class='edit-github'><a href='https://github.com/balloob/home-assistant.io/tree/master/source/developers/rest_api.markdown'>Edit this page on GitHub</a></div>
|
|
|
|
|
|
|
|
<header>
|
|
<h1 class="title indent">
|
|
RESTful API
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
|
|
|
|
<p>Home Assistant runs a web server accessible on port 8123.</p>
|
|
|
|
<ul>
|
|
<li>http://IP_ADDRESS:8123/ is an interface to control Home Assistant.</li>
|
|
<li>http://IP_ADDRESS:8123/api/ is a Rest API.</li>
|
|
</ul>
|
|
|
|
<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> (YOUR_PASSWORD as specified in your <code>configuration.yaml</code> file in the <a href="/components/http/"><code>http:</code> section</a>).</p>
|
|
|
|
<p>There are multiple ways to consume the Home Assistant Rest API. One is with <code>curl</code>:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>curl -X GET \
|
|
-H "x-ha-access: YOUR_PASSWORD" \
|
|
http://IP_ADDRESS:8123/ENDPOINT
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Another option is to use Python and the <a href="http://docs.python-requests.org/en/latest/">Requests</a> module.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre><span class="keyword">from</span> <span class="include">requests</span> <span class="keyword">import</span> <span class="include">get</span>
|
|
|
|
url = <span class="string"><span class="delimiter">'</span><span class="content">http://localhost:8123/ENDPOINT</span><span class="delimiter">'</span></span>
|
|
headers = {<span class="string"><span class="delimiter">'</span><span class="content">x-ha-access</span><span class="delimiter">'</span></span>: <span class="string"><span class="delimiter">'</span><span class="content">YOUR_PASSWORD</span><span class="delimiter">'</span></span>,
|
|
<span class="string"><span class="delimiter">'</span><span class="content">content-type</span><span class="delimiter">'</span></span>: <span class="string"><span class="delimiter">'</span><span class="content">application/json</span><span class="delimiter">'</span></span>}
|
|
|
|
response = get(url, headers=headers)
|
|
print(response.text)
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p class="note">
|
|
You can append <code>?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>
|
|
<li>400 (Bad Request)</li>
|
|
<li>401 (Unauthorized)</li>
|
|
<li>404 (Not Found)</li>
|
|
<li>405 (Method not allowed)</li>
|
|
</ul>
|
|
|
|
<h3><a class="title-link" name="actions" href="#actions"></a> Actions</h3>
|
|
|
|
<p>The API supports the following actions:</p>
|
|
|
|
<h4><a class="title-link" name="get-api" href="#get-api"></a> GET /api/</h4>
|
|
<p>Returns message if API is up and running.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">message</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">API running.</span><span class="delimiter">"</span></span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Sample <code>curl</code> command:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" http://localhost:8123/api/
|
|
</pre></div>
|
|
</div>
|
|
</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="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">components</span><span class="delimiter">"</span></span>: [
|
|
<span class="string"><span class="delimiter">"</span><span class="content">recorder</span><span class="delimiter">"</span></span>,
|
|
<span class="string"><span class="delimiter">"</span><span class="content">http</span><span class="delimiter">"</span></span>,
|
|
<span class="string"><span class="delimiter">"</span><span class="content">sensor.time_date</span><span class="delimiter">"</span></span>,
|
|
<span class="string"><span class="delimiter">"</span><span class="content">api</span><span class="delimiter">"</span></span>,
|
|
<span class="string"><span class="delimiter">"</span><span class="content">frontend</span><span class="delimiter">"</span></span>,
|
|
<span class="string"><span class="delimiter">"</span><span class="content">sun</span><span class="delimiter">"</span></span>,
|
|
<span class="string"><span class="delimiter">"</span><span class="content">logbook</span><span class="delimiter">"</span></span>,
|
|
<span class="string"><span class="delimiter">"</span><span class="content">history</span><span class="delimiter">"</span></span>,
|
|
<span class="string"><span class="delimiter">"</span><span class="content">group</span><span class="delimiter">"</span></span>,
|
|
<span class="string"><span class="delimiter">"</span><span class="content">automation</span><span class="delimiter">"</span></span>
|
|
],
|
|
<span class="key"><span class="delimiter">"</span><span class="content">latitude</span><span class="delimiter">"</span></span>: <span class="float">44.1234</span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">location_name</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Home</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">longitude</span><span class="delimiter">"</span></span>: <span class="float">5.5678</span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">temperature_unit</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="char">\u00b0</span><span class="content">C</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">time_zone</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Europe/Zurich</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">version</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">0.8.0.dev0</span><span class="delimiter">"</span></span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Sample <code>curl</code> command:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" http://localhost:8123/api/config
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="get-apibootstrap" href="#get-apibootstrap"></a> GET /api/bootstrap</h4>
|
|
<p>Returns all data needed to bootstrap Home Assistant.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">config</span><span class="delimiter">"</span></span>: {<span class="error">.</span><span class="error">.</span><span class="error">.</span>},
|
|
<span class="key"><span class="delimiter">"</span><span class="content">events</span><span class="delimiter">"</span></span>: [<span class="error">.</span><span class="error">.</span><span class="error">.</span>],
|
|
<span class="key"><span class="delimiter">"</span><span class="content">services</span><span class="delimiter">"</span></span>: [<span class="error">.</span><span class="error">.</span><span class="error">.</span>],
|
|
<span class="key"><span class="delimiter">"</span><span class="content">states</span><span class="delimiter">"</span></span>: [<span class="error">.</span><span class="error">.</span><span class="error">.</span>]
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Sample <code>curl</code> command:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" http://localhost:8123/api/bootstrap
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="get-apievents" href="#get-apievents"></a> GET /api/events</h4>
|
|
<p>Returns an array of event objects. Each event object contain event name and listener count.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>[
|
|
{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">event</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">state_changed</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">listener_count</span><span class="delimiter">"</span></span>: <span class="integer">5</span>
|
|
},
|
|
{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">event</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">time_changed</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">listener_count</span><span class="delimiter">"</span></span>: <span class="integer">2</span>
|
|
}
|
|
]
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Sample <code>curl</code> command:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" http://localhost:8123/api/events
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="get-apiservices" href="#get-apiservices"></a> GET /api/services</h4>
|
|
<p>Returns an array of service objects. Each object contains the domain and which services it contains.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>[
|
|
{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">domain</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">browser</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">services</span><span class="delimiter">"</span></span>: [
|
|
<span class="string"><span class="delimiter">"</span><span class="content">browse_url</span><span class="delimiter">"</span></span>
|
|
]
|
|
},
|
|
{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">domain</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">keyboard</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">services</span><span class="delimiter">"</span></span>: [
|
|
<span class="string"><span class="delimiter">"</span><span class="content">volume_up</span><span class="delimiter">"</span></span>,
|
|
<span class="string"><span class="delimiter">"</span><span class="content">volume_down</span><span class="delimiter">"</span></span>
|
|
]
|
|
}
|
|
]
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Sample <code>curl</code> command:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" http://localhost:8123/api/services
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="get-apihistory" href="#get-apihistory"></a> GET /api/history</h4>
|
|
<p>Returns an array of state changes in the past. Each object contains further detail for the entities.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>[
|
|
[
|
|
{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">attributes</span><span class="delimiter">"</span></span>: {
|
|
<span class="key"><span class="delimiter">"</span><span class="content">friendly_name</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Weather Temperature</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">unit_of_measurement</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="char">\u00b0</span><span class="content">C</span><span class="delimiter">"</span></span>
|
|
},
|
|
<span class="key"><span class="delimiter">"</span><span class="content">entity_id</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">sensor.weather_temperature</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">last_changed</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">23:30:00 05-02-2016</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">last_updated</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">23:30:00 05-02-2016</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">-3.9</span><span class="delimiter">"</span></span>
|
|
},
|
|
{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">attributes</span><span class="delimiter">"</span></span>: {
|
|
<span class="key"><span class="delimiter">"</span><span class="content">friendly_name</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Weather Temperature</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">unit_of_measurement</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="char">\u00b0</span><span class="content">C</span><span class="delimiter">"</span></span>
|
|
},
|
|
<span class="key"><span class="delimiter">"</span><span class="content">entity_id</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">sensor.weather_temperature</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">last_changed</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">07:03:30 06-02-2016</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">last_updated</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">07:03:30 06-02-2016</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">-1.9</span><span class="delimiter">"</span></span>
|
|
},
|
|
]
|
|
]
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Sample <code>curl</code> commands:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" http://localhost:8123/api/history/period/2016-02-06
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" http://localhost:8123/api/history/period/2016-02-06?filter_entity_id=sensor.temperature
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="get-apistates" href="#get-apistates"></a> GET /api/states</h4>
|
|
<p>Returns an array of state objects. Each state has the following attributes: entity_id, state, last_changed and attributes.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>[
|
|
{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">attributes</span><span class="delimiter">"</span></span>: {
|
|
<span class="key"><span class="delimiter">"</span><span class="content">next_rising</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">07:04:15 29-10-2013</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">next_setting</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">18:00:31 29-10-2013</span><span class="delimiter">"</span></span>
|
|
},
|
|
<span class="key"><span class="delimiter">"</span><span class="content">entity_id</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">sun.sun</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">last_changed</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">23:24:33 28-10-2013</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">below_horizon</span><span class="delimiter">"</span></span>
|
|
},
|
|
{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">attributes</span><span class="delimiter">"</span></span>: {},
|
|
<span class="key"><span class="delimiter">"</span><span class="content">entity_id</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">process.Dropbox</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">last_changed</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">23:24:33 28-10-2013</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">on</span><span class="delimiter">"</span></span>
|
|
}
|
|
]
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Sample <code>curl</code> command:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" http://localhost:8123/api/states
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="get-apistatesltentity_id" href="#get-apistatesltentity_id"></a> GET /api/states/<entity_id></h4>
|
|
<p>Returns a state object for specified entity_id. Returns 404 if not found.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">attributes</span><span class="delimiter">"</span></span>: {
|
|
<span class="key"><span class="delimiter">"</span><span class="content">next_rising</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">07:04:15 29-10-2013</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">next_setting</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">18:00:31 29-10-2013</span><span class="delimiter">"</span></span>
|
|
},
|
|
<span class="key"><span class="delimiter">"</span><span class="content">entity_id</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">sun.sun</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">last_changed</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">23:24:33 28-10-2013</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">below_horizon</span><span class="delimiter">"</span></span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Sample <code>curl</code> command:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \
|
|
http://localhost:8123/api/states/sensor.kitchen_temperature
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="get-apierror_log" href="#get-apierror_log"></a> GET /api/error_log</h4>
|
|
<p>Retrieve all errors logged during the current session of Home Assistant as a plaintext response.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>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
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Sample <code>curl</code> command:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \
|
|
http://localhost:8123/api/error_log
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="post-apistatesltentity_id" href="#post-apistatesltentity_id"></a> POST /api/states/<entity_id></h4>
|
|
<p>Updates or creates the current state of an entity.</p>
|
|
|
|
<p>Expects a JSON object that has at least a state attribute:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">below_horizon</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">attributes</span><span class="delimiter">"</span></span>: {
|
|
<span class="key"><span class="delimiter">"</span><span class="content">next_rising</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">07:04:15 29-10-2013</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">next_setting</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">18:00:31 29-10-2013</span><span class="delimiter">"</span></span>
|
|
}
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<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.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">attributes</span><span class="delimiter">"</span></span>: {
|
|
<span class="key"><span class="delimiter">"</span><span class="content">next_rising</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">07:04:15 29-10-2013</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">next_setting</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">18:00:31 29-10-2013</span><span class="delimiter">"</span></span>
|
|
},
|
|
<span class="key"><span class="delimiter">"</span><span class="content">entity_id</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">weather.sun</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">last_changed</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">23:24:33 28-10-2013</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">below_horizon</span><span class="delimiter">"</span></span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Sample <code>curl</code> command:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \
|
|
-d '{"state": "25", "attributes": {"unit_of_measurement": "°C"}}' \
|
|
http://localhost:8123/api/states/sensor.kitchen_temperature
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="post-apieventsltevent_type" href="#post-apieventsltevent_type"></a> POST /api/events/<event_type></h4>
|
|
<p>Fires an event with event_type</p>
|
|
|
|
<p>You can pass an optional JSON object to be used as <code>event_data</code>.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">next_rising</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">18:00:31 29-10-2013</span><span class="delimiter">"</span></span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Returns a message if successful.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">message</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Event download_file fired.</span><span class="delimiter">"</span></span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="post-apiservicesltdomainltservice" href="#post-apiservicesltdomainltservice"></a> POST /api/services/<domain>/<service></h4>
|
|
<p>Calls a service within a specific domain. Will return when the service has been executed or 10 seconds has past, whichever comes first.</p>
|
|
|
|
<p>You can pass an optional JSON object to be used as <code>service_data</code>.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">entity_id</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">light.Ceiling</span><span class="delimiter">"</span></span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Returns a list of states that have changed while the service was being executed.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>[
|
|
{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">attributes</span><span class="delimiter">"</span></span>: {
|
|
<span class="key"><span class="delimiter">"</span><span class="content">next_rising</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">07:04:15 29-10-2013</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">next_setting</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">18:00:31 29-10-2013</span><span class="delimiter">"</span></span>
|
|
},
|
|
<span class="key"><span class="delimiter">"</span><span class="content">entity_id</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">sun.sun</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">last_changed</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">23:24:33 28-10-2013</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">below_horizon</span><span class="delimiter">"</span></span>
|
|
},
|
|
{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">attributes</span><span class="delimiter">"</span></span>: {},
|
|
<span class="key"><span class="delimiter">"</span><span class="content">entity_id</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">process.Dropbox</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">last_changed</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">23:24:33 28-10-2013</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">state</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">on</span><span class="delimiter">"</span></span>
|
|
}
|
|
]
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Sample <code>curl</code> command:</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>$ curl -X POST -H "x-ha-access: YOUR_PASSWORD" \
|
|
-d '{"entity_id": "switch.christmas_lights", "state": "on"}' \
|
|
http://localhost:8123/api/services/switch/turn_on
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p class="note">
|
|
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>
|
|
|
|
<h4><a class="title-link" name="post-apitemplate" href="#post-apitemplate"></a> POST /api/template</h4>
|
|
<p>Render a Home Assistant template. <a href="/getting-started/templating/">See template docs for more information.</a></p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">template</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Paulus is at {{ states('device_tracker.paulus') }}!</span><span class="delimiter">"</span></span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>Returns the rendered template in plain text.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>Paulus is at work!
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="post-apievent_forwarding" href="#post-apievent_forwarding"></a> POST /api/event_forwarding</h4>
|
|
<p>Setup event forwarding to another Home Assistant instance.</p>
|
|
|
|
<p>Requires a JSON object that represents the API to forward to.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">host</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">machine</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">api_password</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">my_super_secret_password</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">port</span><span class="delimiter">"</span></span>: <span class="integer">8880</span> <span class="error">/</span><span class="error">/</span> <span class="error">o</span><span class="error">p</span><span class="error">t</span><span class="error">i</span><span class="error">o</span><span class="error">n</span><span class="error">a</span><span class="error">l</span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>It will return a message if event forwarding was setup successful.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">message</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Event forwarding setup.</span><span class="delimiter">"</span></span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<h4><a class="title-link" name="delete-apievent_forwarding" href="#delete-apievent_forwarding"></a> DELETE /api/event_forwarding</h4>
|
|
<p>Cancel event forwarding to another Home Assistant instance.<br /></p>
|
|
|
|
<p>Requires a JSON object that represents the API to cancel forwarding to.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">host</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">machine</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">api_password</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">my_super_secret_password</span><span class="delimiter">"</span></span>,
|
|
<span class="key"><span class="delimiter">"</span><span class="content">port</span><span class="delimiter">"</span></span>: <span class="integer">8880</span> <span class="error">/</span><span class="error">/</span> <span class="error">o</span><span class="error">p</span><span class="error">t</span><span class="error">i</span><span class="error">o</span><span class="error">n</span><span class="error">a</span><span class="error">l</span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p>It will return a message if event forwarding was cancelled successful.</p>
|
|
|
|
<div class="highlighter-coderay"><div class="CodeRay">
|
|
<div class="code"><pre>{
|
|
<span class="key"><span class="delimiter">"</span><span class="content">message</span><span class="delimiter">"</span></span>: <span class="string"><span class="delimiter">"</span><span class="content">Event forwarding cancelled.</span><span class="delimiter">"</span></span>
|
|
}
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
|
|
<p class="note">
|
|
If your client does not support <code>DELETE</code> HTTP requests you can add an optional attribute <code>_METHOD</code> and set its value to <code>DELETE</code>.
|
|
</p>
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
<div class="grid__item">
|
|
<div class="copyright">
|
|
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
|
<a rel="me" href='https://github.com/balloob/home-assistant'><i class="icon-github"></i></a>
|
|
|
|
<div class="credit">
|
|
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
|
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
|
</div>
|
|
</div>
|
|
</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]-->
|
|
|
|
<script>
|
|
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
|
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
|
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
|
s.parentNode.insertBefore(g,s)}(document,'script'));
|
|
</script>
|
|
|
|
</body>
|
|
</html> |