You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2016/11/01 21:44:30 UTC
[06/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html
index 61a26ed..562b368 100644
--- a/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html
+++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html
@@ -35,7 +35,7 @@
<link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
- <link rel="next" title="Federation" href="federation.html"/>
+ <link rel="next" title="Divisions" href="division.html"/>
<link rel="prev" title="Delivery Service" href="deliveryservice.html"/>
@@ -177,7 +177,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="federation.html" class="btn btn-neutral float-right" title="Federation">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="division.html" class="btn btn-neutral float-right" title="Divisions">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -316,61 +316,61 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"source"</span><span class="p">:</span> <span class="s">"TrafficStats"</span><span class="p">,</span>
- <span class="s">"summary"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"average"</span><span class="p">:</span> <span class="mf">1081172.785</span><span class="p">,</span>
- <span class="s">"count"</span><span class="p">:</span> <span class="mi">28</span><span class="p">,</span>
- <span class="s">"fifthPercentile"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span>
- <span class="s">"max"</span><span class="p">:</span> <span class="mf">1326680.31</span><span class="p">,</span>
- <span class="s">"min"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span>
- <span class="s">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span>
- <span class="s">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span>
- <span class="s">"totalBytes"</span><span class="p">:</span> <span class="mf">37841047.475</span><span class="p">,</span>
- <span class="s">"totalTransactions"</span><span class="p">:</span> <span class="mi">1020202030101</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"source"</span><span class="p">:</span> <span class="s2">"TrafficStats"</span><span class="p">,</span>
+ <span class="s2">"summary"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"average"</span><span class="p">:</span> <span class="mf">1081172.785</span><span class="p">,</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">28</span><span class="p">,</span>
+ <span class="s2">"fifthPercentile"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1326680.31</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span>
+ <span class="s2">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span>
+ <span class="s2">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span>
+ <span class="s2">"totalBytes"</span><span class="p">:</span> <span class="mf">37841047.475</span><span class="p">,</span>
+ <span class="s2">"totalTransactions"</span><span class="p">:</span> <span class="mi">1020202030101</span>
<span class="p">},</span>
- <span class="s">"series"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"columns"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"time"</span><span class="p">,</span>
- <span class="s">""</span>
+ <span class="s2">"series"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"columns"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"time"</span><span class="p">,</span>
+ <span class="s2">""</span>
<span class="p">],</span>
- <span class="s">"count"</span><span class="p">:</span> <span class="mi">60</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"kbps"</span><span class="p">,</span>
- <span class="s">"tags"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"total"</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">60</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"kbps"</span><span class="p">,</span>
+ <span class="s2">"tags"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"total"</span>
<span class="p">},</span>
- <span class="s">"values"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"values"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
- <span class="s">"2015-08-11T11:36:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-11T11:36:00Z"</span><span class="p">,</span>
<span class="mf">888827.26</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-11T11:37:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-11T11:37:00Z"</span><span class="p">,</span>
<span class="mf">980336.563333333</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-11T11:38:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-11T11:38:00Z"</span><span class="p">,</span>
<span class="mf">952111.975</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-11T11:39:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-11T11:39:00Z"</span><span class="p">,</span>
<span class="n">null</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-11T11:43:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-11T11:43:00Z"</span><span class="p">,</span>
<span class="n">null</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-11T11:44:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-11T11:44:00Z"</span><span class="p">,</span>
<span class="mf">934682.943333333</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-11T11:45:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-11T11:45:00Z"</span><span class="p">,</span>
<span class="mf">1251121.28</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-11T11:46:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-11T11:46:00Z"</span><span class="p">,</span>
<span class="mf">1111012.99</span>
<span class="p">]</span>
<span class="p">]</span>
@@ -392,7 +392,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="federation.html" class="btn btn-neutral float-right" title="Federation">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="division.html" class="btn btn-neutral float-right" title="Divisions">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/division.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/division.html b/docs/latest/development/traffic_ops_api/v12/division.html
index 2cbf37c..469bf82 100644
--- a/docs/latest/development/traffic_ops_api/v12/division.html
+++ b/docs/latest/development/traffic_ops_api/v12/division.html
@@ -35,8 +35,8 @@
<link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
- <link rel="next" title="Regions" href="region.html"/>
- <link rel="prev" title="InfluxDB" href="influxdb.html"/>
+ <link rel="next" title="Federation" href="federation.html"/>
+ <link rel="prev" title="Delivery Service Statistics" href="deliveryservice_stats.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -177,10 +177,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="federation.html" class="btn btn-neutral float-right" title="Federation">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="influxdb.html" class="btn btn-neutral" title="InfluxDB"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="deliveryservice_stats.html" class="btn btn-neutral" title="Delivery Service Statistics"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -191,6 +191,216 @@
<div class="section" id="api-1-2-divisions">
<span id="to-api-v12-division-route"></span><h2>/api/1.2/divisions<a class="headerlink" href="#api-1-2-divisions" title="Permalink to this headline">�</a></h2>
<dl class="docutils">
+<dt><strong>GET /api/1.2/divisions</strong></dt>
+<dd><p class="first">Get all divisions.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Division id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Division name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Central"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"West"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>GET /api/1.2/divisions/:id</strong></dt>
+<dd><p class="first">Get division by Id.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Division id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Division name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Central"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>PUT /api/1.2/divisions/:id</strong></dt>
+<dd><p class="first">Update a division</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Division id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="21%" />
+<col width="55%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the division</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Division update was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
<dt><strong>POST /api/1.2/divisions</strong></dt>
<dd><p class="first">Create division</p>
<p>Authentication Required: Yes</p>
@@ -216,8 +426,8 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"mydivision1"</span>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -252,10 +462,10 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">'name'</span><span class="p">:</span> <span class="s">'mydivision1'</span><span class="p">,</span>
- <span class="s">'id'</span><span class="p">:</span> <span class="s">'4'</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'4'</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -273,10 +483,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="federation.html" class="btn btn-neutral float-right" title="Federation">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="influxdb.html" class="btn btn-neutral" title="InfluxDB"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="deliveryservice_stats.html" class="btn btn-neutral" title="Delivery Service Statistics"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/federation.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/federation.html b/docs/latest/development/traffic_ops_api/v12/federation.html
index 7fd13b6..5e99ff6 100644
--- a/docs/latest/development/traffic_ops_api/v12/federation.html
+++ b/docs/latest/development/traffic_ops_api/v12/federation.html
@@ -36,7 +36,7 @@
<link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Hardware Info" href="hwinfo.html"/>
- <link rel="prev" title="Delivery Service Statistics" href="deliveryservice_stats.html"/>
+ <link rel="prev" title="Divisions" href="division.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -180,7 +180,7 @@
<a href="hwinfo.html" class="btn btn-neutral float-right" title="Hardware Info">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="deliveryservice_stats.html" class="btn btn-neutral" title="Delivery Service Statistics"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="division.html" class="btn btn-neutral" title="Divisions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -224,17 +224,17 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- "mappings": [
- "cname": "cname-01.",
- "ttl": 8865,
- ]
- "deliveryService": "ds-01",
- }
- ]
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"cname-01."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">8865</span><span class="p">,</span>
+ <span class="p">]</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -275,16 +275,16 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"federations"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"federations"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"ccp-omg-01"</span><span class="p">,</span>
- <span class="s">"mappings"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"resolve4"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"255.255.255.255"</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span>
+ <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"resolve4"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"255.255.255.255"</span>
<span class="p">],</span>
- <span class="s">"resolve6"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span>
+ <span class="s2">"resolve6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
@@ -339,16 +339,16 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"federations"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"federations"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"ccp-omg-01"</span><span class="p">,</span>
- <span class="s">"mappings"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"resolve4"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"255.255.255.255"</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span>
+ <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"resolve4"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"255.255.255.255"</span>
<span class="p">],</span>
- <span class="s">"resolve6"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span>
+ <span class="s2">"resolve6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
@@ -372,7 +372,7 @@
<a href="hwinfo.html" class="btn btn-neutral float-right" title="Hardware Info">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="deliveryservice_stats.html" class="btn btn-neutral" title="Delivery Service Statistics"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="division.html" class="btn btn-neutral" title="Divisions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/hwinfo.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/hwinfo.html b/docs/latest/development/traffic_ops_api/v12/hwinfo.html
index 3fffa7a..3dbd399 100644
--- a/docs/latest/development/traffic_ops_api/v12/hwinfo.html
+++ b/docs/latest/development/traffic_ops_api/v12/hwinfo.html
@@ -231,19 +231,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"serverId"</span><span class="p">:</span> <span class="s">"odol-atsmid-cen-09"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-05-27 09:06:02"</span><span class="p">,</span>
- <span class="s">"val"</span><span class="p">:</span> <span class="s">"D1S4"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Physical Disk 0:1:0"</span>
+ <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span>
+ <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:0"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"serverId"</span><span class="p">:</span> <span class="s">"odol-atsmid-cen-09"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-05-27 09:06:02"</span><span class="p">,</span>
- <span class="s">"val"</span><span class="p">:</span> <span class="s">"D1S4"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Physical Disk 0:1:1"</span>
+ <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span>
+ <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:1"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/influxdb.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/influxdb.html b/docs/latest/development/traffic_ops_api/v12/influxdb.html
index 4519e63..060dba3 100644
--- a/docs/latest/development/traffic_ops_api/v12/influxdb.html
+++ b/docs/latest/development/traffic_ops_api/v12/influxdb.html
@@ -35,8 +35,8 @@
<link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
- <link rel="next" title="Divisions" href="division.html"/>
- <link rel="prev" title="Profiles" href="profile.html"/>
+ <link rel="next" title="Regions" href="region.html"/>
+ <link rel="prev" title="Profile parameters" href="profile_parameter.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -177,10 +177,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="division.html" class="btn btn-neutral float-right" title="Divisions">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="profile.html" class="btn btn-neutral" title="Profiles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="profile_parameter.html" class="btn btn-neutral" title="Profile parameters"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -216,28 +216,28 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"aaData"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"aaData"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
- <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"ALL"</span><span class="p">,</span>
- <span class="s">"ALL"</span><span class="p">,</span>
- <span class="s">"ALL"</span><span class="p">,</span>
- <span class="s">"true"</span><span class="p">,</span>
- <span class="s">"ALL"</span><span class="p">,</span>
- <span class="s">"142035"</span><span class="p">,</span>
- <span class="s">"172365661.85"</span>
+ <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"true"</span><span class="p">,</span>
+ <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"142035"</span><span class="p">,</span>
+ <span class="s2">"172365661.85"</span>
<span class="p">],</span>
<span class="p">[</span>
<span class="mi">1</span><span class="p">,</span>
- <span class="s">"EDGE1_TOP_421_PSPP"</span><span class="p">,</span>
- <span class="s">"odol-atsec-atl-03"</span><span class="p">,</span>
- <span class="s">"us-ga-atlanta"</span><span class="p">,</span>
- <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"REPORTED"</span><span class="p">,</span>
- <span class="s">"596"</span><span class="p">,</span>
- <span class="s">"923510.04"</span><span class="p">,</span>
- <span class="s">"69.241.82.126"</span>
+ <span class="s2">"EDGE1_TOP_421_PSPP"</span><span class="p">,</span>
+ <span class="s2">"odol-atsec-atl-03"</span><span class="p">,</span>
+ <span class="s2">"us-ga-atlanta"</span><span class="p">,</span>
+ <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"REPORTED"</span><span class="p">,</span>
+ <span class="s2">"596"</span><span class="p">,</span>
+ <span class="s2">"923510.04"</span><span class="p">,</span>
+ <span class="s2">"69.241.82.126"</span>
<span class="p">]</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -251,10 +251,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="division.html" class="btn btn-neutral float-right" title="Divisions">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="profile.html" class="btn btn-neutral" title="Profiles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="profile_parameter.html" class="btn btn-neutral" title="Profile parameters"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/parameter.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/parameter.html b/docs/latest/development/traffic_ops_api/v12/parameter.html
index d2c3be0..9e264e4 100644
--- a/docs/latest/development/traffic_ops_api/v12/parameter.html
+++ b/docs/latest/development/traffic_ops_api/v12/parameter.html
@@ -190,7 +190,7 @@
<span id="to-api-v12-parameter"></span><h1>Parameter<a class="headerlink" href="#parameter" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-parameters">
<span id="to-api-v12-parameters-route"></span><h2>/api/1.2/parameters<a class="headerlink" href="#api-1-2-parameters" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/parameters.json</strong></p>
+<p><strong>GET /api/1.2/parameters</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -231,28 +231,28 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
- <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span>
- <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
- <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"records.config"</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -262,16 +262,75 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/parameters/profile/:name.json</strong></p>
+<p><strong>GET /api/1.2/parameters/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: if secure of the parameter fetched is 1, require admin role, or any valid role can access.</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter index</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/profiles/:id/parameters</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="44%" />
-<col width="24%" />
-<col width="32%" />
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
@@ -280,9 +339,9 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile_name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>yes</td>
-<td> </td>
+<td>Profile id</td>
</tr>
</tbody>
</table>
@@ -323,28 +382,28 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
- <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span>
- <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
- <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"records.config"</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -354,6 +413,587 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>GET /api/1.2/profiles/name/:name/parameters</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>Profile name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">last_updated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/parameters</strong></dt>
+<dd><p class="first">Create parameters.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong>
+The request route parameters accept 2 formats, both single paramter and parameters array formats are acceptable.</p>
+<p>single parameter format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="8%" />
+<col width="7%" />
+<col width="71%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">configFile</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secure</span></code></td>
+<td>yes</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p>parameters array format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="8%" />
+<col width="7%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>yes</td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>configFile</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>value</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>secure</span></code></td>
+<td>yes</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="8%" />
+<col width="77%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>configFile</span></code></td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>value</span></code></td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>secure</span></code></td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<ol class="arabic simple">
+<li>single parameter format exampe:</li>
+</ol>
+<blockquote>
+<div><dl class="docutils">
+<dt>{</dt>
+<dd>“name”:”param1”,
+“configFile”:”configFile1”
+“value”:”value1”,
+“secure”:0,</dd>
+</dl>
+<p>}</p>
+</div></blockquote>
+<ol class="arabic simple" start="2">
+<li>array format example:</li>
+</ol>
+<blockquote>
+<div><dl class="docutils">
+<dt>[</dt>
+<dd><dl class="first docutils">
+<dt>{</dt>
+<dd>“name”:”param1”,
+“configFile”:”configFile1”
+“value”:”value1”,
+“secure”:0,</dd>
+</dl>
+<p>},
+{</p>
+<blockquote>
+<div>“name”:”param2”,
+“configFile”:”configFile2”
+“value”:”value2”,
+“secure”:1,</div></blockquote>
+<p class="last">}</p>
+</dd>
+</dl>
+<p>]</p>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1139"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1140"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>PUT /api/1.2/parameters/{:id}</strong></dt>
+<dd><p class="first">Edit parameter.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: if the parameter’s secure equals 1, only admin role can edit the parameter, or admin or oper role can access the API.</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="24%" />
+<col width="47%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="8%" />
+<col width="7%" />
+<col width="71%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>no</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">configFile</span></code></td>
+<td>no</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td>
+<td>no</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secure</span></code></td>
+<td>no</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secure</span></code></td>
+<td>integer</td>
+<td>When 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1134"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>DELETE /api/1.2/parameters/{:id}</strong></dt>
+<dd><p class="first">delete parameter. If the parameter have profile associated, can not be deleted.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper role</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="24%" />
+<col width="47%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>No Request Route Parameters</strong></p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">Response</span> <span class="n">Example</span><span class="p">:</span>
+
+<span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span>
+ <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Parameter was successfully deleted."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/parameters/validate</strong></dt>
+<dd><p class="first">Validate if the parameter exists.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="17%" />
+<col width="55%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type | Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>string | parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">configFile</span></code></td>
+<td>yes</td>
+<td>string | parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td>
+<td>yes</td>
+<td>string | parameter value</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secure</span></code></td>
+<td>integer</td>
+<td>When 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1134"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
</div>
</div>