Browse Source

rebuild docs

pull/14/head
Brett Langdon 11 years ago
parent
commit
ab2488135c
1 changed files with 71 additions and 0 deletions
  1. +71
    -0
      index.html

+ 71
- 0
index.html View File

@ -18,6 +18,8 @@ document.addEventListener("DOMContentLoaded", function(){hljs.initHighlightingOn
<ul class="nav nav-pills"> <ul class="nav nav-pills">
<li role=""><a href="#event">event</a> <li role=""><a href="#event">event</a>
</li> </li>
<li role=""><a href="#host">host</a>
</li>
<li role=""><a href="#infrastructure">infrastructure</a> <li role=""><a href="#infrastructure">infrastructure</a>
</li> </li>
<li role=""><a href="#metric">metric</a> <li role=""><a href="#metric">metric</a>
@ -170,6 +172,75 @@ document.addEventListener("DOMContentLoaded", function(){hljs.initHighlightingOn
</div> </div>
</div> </div>
</section> </section>
<section id="host" class="col-sm-12">
<div class="row">
<h2 class="bg-primary" style="text-indent:1rem">host</h2></div>
<ul class="nav nav-pills">
<li role"presentation"><a href="#host-mute">mute</a></li>
<li role"presentation"><a href="#host-unmute">unmute</a></li>
</ul>
<div class="function row" id="host-mute">
<h3 class="bg-info" style="text-indent:.5rem;padding:.5rem;margin-top:.5rem">mute(hostname, options, callback)</h3>
<div class="col-md-6">
<p>mute the given host, if it is not already muted</p>
<h4>Parameters:</h4>
<dl>
<dt>hostname</dt>
<dd><p>the hostname of the host to mute</p>
</dd>
<dt>options</dt>
<dd><p><em>optional</em>, an object containing any of the following</p>
<ul>
<li>end: POSIX timestamp for when the mute should end</li>
<li>override: whether or not to override the end for an existing mute</li>
</ul>
</dd>
<dt>callback</dt>
<dd><p>function(err, res)</p>
</dd>
</dl>
</div>
<div class="col-md-6">
<pre><code class="lang-javascript">var dogapi = require(&quot;dogapi&quot;);
var options = {
api_key: &quot;api_key&quot;,
app_key: &quot;app_key&quot;
};
dogapi.initialize(options);
dogapi.host.mute(&quot;my.host.name&quot;, function(err, res){
console.dir(res);
});
</code></pre>
</div>
</div>
<div class="function row" id="host-unmute">
<h3 class="bg-info" style="text-indent:.5rem;padding:.5rem;margin-top:.5rem">unmute(hostname, callback)</h3>
<div class="col-md-6">
<p>unmute the given host, if it is not already unmuted</p>
<h4>Parameters:</h4>
<dl>
<dt>hostname</dt>
<dd><p>the hostname of the host to unmute</p>
</dd>
<dt>callback</dt>
<dd><p>function(err, res)</p>
</dd>
</dl>
</div>
<div class="col-md-6">
<pre><code class="lang-javascript">var dogapi = require(&quot;dogapi&quot;);
var options = {
api_key: &quot;api_key&quot;,
app_key: &quot;app_key&quot;
};
dogapi.initialize(options);
dogapi.host.unmute(&quot;my.host.name&quot;, function(err, res){
console.dir(res);
});
</code></pre>
</div>
</div>
</section>
<section id="infrastructure" class="col-sm-12"> <section id="infrastructure" class="col-sm-12">
<div class="row"> <div class="row">
<h2 class="bg-primary" style="text-indent:1rem">infrastructure</h2></div> <h2 class="bg-primary" style="text-indent:1rem">infrastructure</h2></div>


Loading…
Cancel
Save