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

Site updated at 2015-05-15 05:52:31 UTC

Browse source
This commit is contained in:
Paulus Schoutsen 2015-05-14 22:52:31 -07:00
parent f53c01f50d
commit 85a2976dd5
100 changed files with 2892 additions and 747 deletions
Download patch file Download diff file Expand all files Collapse all files

384
developers/api.html
View file

@ -9,20 +9,20 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Rest API - Home Assistant</title>
<title>Home Assistant API - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Home Assistant Rest API documentation">
<meta name="description" content="Home Assistant API documentation">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Rest API">
<meta property="og:title" content="Home Assistant API">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/developers/api.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Home Assistant Rest API documentation">
<meta property="og:description" content="Home Assistant API documentation">
@ -70,12 +70,13 @@
<li><a href="/developers/add_new_platform.html">
Adding platform support
</a></li>
<li><a href="/developers/api.html">Rest API</a></li>
<li><a href="/developers/api.html">API</a></li>
</ul>
</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>
@ -97,384 +98,21 @@
<header>
<h1 class="title indent">
Rest API
Home Assistant API
</h1>
</header>
<hr class="divider">
<p>Home Assistant runs a web server accessible on port 8123.</p>
<p>Home Assistant is offering a RESTful API and a Python API for convenient access to
a Home Assistant instance over HTTP.</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>
<li><a href="/developers/rest_api.html">Rest API</a></li>
<li><a href="/developers/python_api.html">Python API</a></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> (YOUR_PASSWORD as specified in your <code>configuration.yaml</code>).</p>
<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>
<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>
<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">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;API running.&quot;</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<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>
<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">&quot;event&quot;</span><span class="p">:</span> <span class="s2">&quot;state_changed&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;listener_count&quot;</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">&quot;event&quot;</span><span class="p">:</span> <span class="s2">&quot;time_changed&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;listener_count&quot;</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>
<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>
<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">&quot;domain&quot;</span><span class="p">:</span> <span class="s2">&quot;browser&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;services&quot;</span><span class="p">:</span> <span class="p">[</span>
</span><span class='line'> <span class="s2">&quot;browse_url&quot;</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">&quot;domain&quot;</span><span class="p">:</span> <span class="s2">&quot;keyboard&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;services&quot;</span><span class="p">:</span> <span class="p">[</span>
</span><span class='line'> <span class="s2">&quot;volume_up&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="s2">&quot;volume_down&quot;</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>
<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>
<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">&quot;attributes&quot;</span><span class="p">:</span> <span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;next_rising&quot;</span><span class="p">:</span> <span class="s2">&quot;07:04:15 29-10-2013&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;next_setting&quot;</span><span class="p">:</span> <span class="s2">&quot;18:00:31 29-10-2013&quot;</span>
</span><span class='line'> <span class="p">},</span>
</span><span class='line'> <span class="nt">&quot;entity_id&quot;</span><span class="p">:</span> <span class="s2">&quot;sun.sun&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;last_changed&quot;</span><span class="p">:</span> <span class="s2">&quot;23:24:33 28-10-2013&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;state&quot;</span><span class="p">:</span> <span class="s2">&quot;below_horizon&quot;</span>
</span><span class='line'> <span class="p">},</span>
</span><span class='line'> <span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;attributes&quot;</span><span class="p">:</span> <span class="p">{},</span>
</span><span class='line'> <span class="nt">&quot;entity_id&quot;</span><span class="p">:</span> <span class="s2">&quot;process.Dropbox&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;last_changed&quot;</span><span class="p">:</span> <span class="s2">&quot;23:24:33 28-10-2013&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;state&quot;</span><span class="p">:</span> <span class="s2">&quot;on&quot;</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>
<h4><a class='title-link' name='get-apistatesltentity_id' href='#get-apistatesltentity_id'></a> GET /api/states/&lt;entity_id></h4>
<p>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">&quot;attributes&quot;</span><span class="p">:</span> <span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;next_rising&quot;</span><span class="p">:</span> <span class="s2">&quot;07:04:15 29-10-2013&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;next_setting&quot;</span><span class="p">:</span> <span class="s2">&quot;18:00:31 29-10-2013&quot;</span>
</span><span class='line'> <span class="p">},</span>
</span><span class='line'> <span class="nt">&quot;entity_id&quot;</span><span class="p">:</span> <span class="s2">&quot;sun.sun&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;last_changed&quot;</span><span class="p">:</span> <span class="s2">&quot;23:24:33 28-10-2013&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;state&quot;</span><span class="p">:</span> <span class="s2">&quot;below_horizon&quot;</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<h4><a class='title-link' name='post-apistatesltentity_id' href='#post-apistatesltentity_id'></a> POST /api/states/&lt;entity_id></h4>
<p>Updates or creates the current state of an entity.</p>
<p>Expects a JSON object that has atleast a state attribute:</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>
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;state&quot;</span><span class="p">:</span> <span class="s2">&quot;below_horizon&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;attributes&quot;</span><span class="p">:</span> <span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;next_rising&quot;</span><span class="p">:</span> <span class="s2">&quot;07:04:15 29-10-2013&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;next_setting&quot;</span><span class="p">:</span> <span class="s2">&quot;18:00:31 29-10-2013&quot;</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>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>
<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">&quot;attributes&quot;</span><span class="p">:</span> <span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;next_rising&quot;</span><span class="p">:</span> <span class="s2">&quot;07:04:15 29-10-2013&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;next_setting&quot;</span><span class="p">:</span> <span class="s2">&quot;18:00:31 29-10-2013&quot;</span>
</span><span class='line'> <span class="p">},</span>
</span><span class='line'> <span class="nt">&quot;entity_id&quot;</span><span class="p">:</span> <span class="s2">&quot;weather.sun&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;last_changed&quot;</span><span class="p">:</span> <span class="s2">&quot;23:24:33 28-10-2013&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;state&quot;</span><span class="p">:</span> <span class="s2">&quot;below_horizon&quot;</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<h4><a class='title-link' name='post-apieventsltevent_type' href='#post-apieventsltevent_type'></a> POST /api/events/&lt;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>
<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">&quot;next_rising&quot;</span><span class="p">:</span> <span class="s2">&quot;18:00:31 29-10-2013&quot;</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<p>Returns a message if successful.</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">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Event download_file fired.&quot;</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<h4><a class='title-link' name='post-apiservicesltdomainltservice' href='#post-apiservicesltdomainltservice'></a> POST /api/services/&lt;domain>/&lt;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>
<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">&quot;entity_id&quot;</span><span class="p">:</span> <span class="s2">&quot;light.Ceiling&quot;</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<p>Returns a list of states that have changed while the service was being executed.</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">&quot;attributes&quot;</span><span class="p">:</span> <span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;next_rising&quot;</span><span class="p">:</span> <span class="s2">&quot;07:04:15 29-10-2013&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;next_setting&quot;</span><span class="p">:</span> <span class="s2">&quot;18:00:31 29-10-2013&quot;</span>
</span><span class='line'> <span class="p">},</span>
</span><span class='line'> <span class="nt">&quot;entity_id&quot;</span><span class="p">:</span> <span class="s2">&quot;sun.sun&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;last_changed&quot;</span><span class="p">:</span> <span class="s2">&quot;23:24:33 28-10-2013&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;state&quot;</span><span class="p">:</span> <span class="s2">&quot;below_horizon&quot;</span>
</span><span class='line'> <span class="p">},</span>
</span><span class='line'> <span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;attributes&quot;</span><span class="p">:</span> <span class="p">{},</span>
</span><span class='line'> <span class="nt">&quot;entity_id&quot;</span><span class="p">:</span> <span class="s2">&quot;process.Dropbox&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;last_changed&quot;</span><span class="p">:</span> <span class="s2">&quot;23:24:33 28-10-2013&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;state&quot;</span><span class="p">:</span> <span class="s2">&quot;on&quot;</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 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-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>
<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>
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;host&quot;</span><span class="p">:</span> <span class="s2">&quot;machine&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;api_password&quot;</span><span class="p">:</span> <span class="s2">&quot;my_super_secret_password&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;port&quot;</span><span class="p">:</span> <span class="mi">8880</span> <span class="err">//</span> <span class="err">optional</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<p>It will return a message if event forwarding was setup successful.</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">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Event forwarding setup.&quot;</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<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>
<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>
</pre></td><td class='code'><pre><code class='json'><span class='line'><span class="p">{</span>
</span><span class='line'> <span class="nt">&quot;host&quot;</span><span class="p">:</span> <span class="s2">&quot;machine&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;api_password&quot;</span><span class="p">:</span> <span class="s2">&quot;my_super_secret_password&quot;</span><span class="p">,</span>
</span><span class='line'> <span class="nt">&quot;port&quot;</span><span class="p">:</span> <span class="mi">8880</span> <span class="err">//</span> <span class="err">optional</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<p>It will return a message if event forwarding was cancelled successful.</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">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Event forwarding cancelled.&quot;</span>
</span><span class='line'><span class="p">}</span>
</span></code></pre></td></tr></table></div></figure>
<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>