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:25 UTC
[01/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Repository: incubator-trafficcontrol-website
Updated Branches:
refs/heads/asf-site 5a61ef535 -> 917167253
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_portal.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_portal.html b/docs/latest/development/traffic_portal.html
index 9e171b9..49904cc 100644
--- a/docs/latest/development/traffic_portal.html
+++ b/docs/latest/development/traffic_portal.html
@@ -119,7 +119,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Portal</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
[38/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/hwinfo.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/hwinfo.html b/docs/1.7.0/development/traffic_ops_api/v11/hwinfo.html
index 06e5c56..b6d2887 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/hwinfo.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/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/1.7.0/development/traffic_ops_api/v11/parameter.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/parameter.html b/docs/1.7.0/development/traffic_ops_api/v11/parameter.html
index 75ce97d..4c91d81 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/parameter.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/parameter.html
@@ -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="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">"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="mi">0</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="mi">0</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>
@@ -323,28 +323,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="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">"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="mi">0</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="mi">0</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>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/phys_location.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/phys_location.html b/docs/1.7.0/development/traffic_ops_api/v11/phys_location.html
index 66a6264..fa0d8ff 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/phys_location.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/phys_location.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-phys-loc"></span><h1>Physical Location<a class="headerlink" href="#physical-location" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-phys-locations">
<span id="to-api-v11-phys-loc-route"></span><h2>/api/1.1/phys_locations<a class="headerlink" href="#api-1-1-phys-locations" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/phys_locations.json</strong></p>
+<p><strong>GET /api/1.1/phys_locations</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,47 +208,47 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</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>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<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">email</span></code></td>
+<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">city</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</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>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -256,40 +256,52 @@
<td>string</td>
<td> </td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
</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">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
- <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"region"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"poc"</span><span class="p">:</span> <span class="s">"John Doe"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(321) 555-1111"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"IL"</span><span class="p">,</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"john.doe@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"60636"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 4th Street"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"chicago"</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -322,19 +334,549 @@
</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">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Ashburn"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Ashburn"</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.1/phys_locations/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Physical location ID.</td>
+</tr>
+</tbody>
+</table>
+<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">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</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">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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>
+<dl class="docutils">
+<dt><strong>PUT /api/1.1/phys_locations/:id</strong></dt>
+<dd><p class="first">Update a physical location</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>Physical location id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</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">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">address</span></code></td>
+<td>yes</td>
+<td>Physical location address.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td>Physical location city.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td>Physical location comments.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>no</td>
+<td>Physical location email.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>Physical location name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td>Physical location phone.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Physical location point of contact.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>no</td>
+<td>Physical location region ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>Physical location short name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td>Physical location state.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td>Physical location zip.</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">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</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">"Physical location 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="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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.1/regions/:region_name/phys_locations</strong></dt>
+<dd><p class="first">Create physical location.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p>region_name: the name of the region to create physical location into.</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="16%" />
+<col width="56%" />
+</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">region_name</span></code></td>
+<td>yes</td>
+<td>The name of the physical location</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</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 location</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>The short name of the location</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Point of contact</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td> </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">"my physical location1"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span>
+ <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"this is physical location1"</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="22%" />
+<col width="11%" />
+<col width="67%" />
+</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>The id of the physical location created.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the location</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>The short name of the location</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionName</span></code></td>
+<td>string</td>
+<td>The region name the physical location belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td>Point of contact</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</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">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span>
+ <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span>
+ <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span>
+ <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span>
+ <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span>
+ <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span>
+ <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span>
+ <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/profile.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/profile.html b/docs/1.7.0/development/traffic_ops_api/v11/profile.html
index bac5795..929aad7 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/profile.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/profile.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-profile"></span><h1>Profiles<a class="headerlink" href="#profiles" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-profiles">
<span id="to-api-v11-profiles-route"></span><h2>/api/1.1/profiles<a class="headerlink" href="#api-1-1-profiles" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/profiles.json</strong></p>
+<p><strong>GET /api/1.1/profiles</strong></p>
<blockquote>
<div><blockquote>
<div><p>Authentication Required: Yes</p>
@@ -229,13 +229,13 @@
</table>
</div></blockquote>
<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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -245,7 +245,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/profiles/trimmed.json</strong></p>
+<p><strong>GET /api/1.1/profiles/trimmed</strong></p>
<blockquote>
<div><blockquote>
<div><p>Authentication Required: Yes</p>
@@ -272,10 +272,85 @@
</table>
</div></blockquote>
<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">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</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.1/profiles/:id</strong></p>
+<blockquote>
+<div><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="22%" />
+<col width="16%" />
+<col width="62%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>The ID of the profile.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="10%" />
+<col width="68%" />
+</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">lastUpdated</span></code></td>
+<td>array</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">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<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">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</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/1.7.0/development/traffic_ops_api/v11/region.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/region.html b/docs/1.7.0/development/traffic_ops_api/v11/region.html
index bcb14dd..a78468c 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/region.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/region.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-region"></span><h1>Regions<a class="headerlink" href="#regions" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-regions">
<span id="to-api-v11-regions-route"></span><h2>/api/1.1/regions<a class="headerlink" href="#api-1-1-regions" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/regions.json</strong></p>
+<p><strong>GET /api/1.1/regions</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,32 +208,339 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td> </td>
+<td>Region ID.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
-<td> </td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</td>
</tr>
</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">"name"</span><span class="p">:</span> <span class="s">"Atlanta"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"6"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Beltway"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"7"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/regions/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Region id.</td>
+</tr>
+</tbody>
+</table>
+<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>Region ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</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">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
+<dl class="docutils">
+<dt><strong>PUT /api/1.1/regions/:id</strong></dt>
+<dd><p class="first">Update a region</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>Region id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="31%" />
+<col width="19%" />
+<col width="50%" />
+</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 region</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>yes</td>
+<td>The division Id</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">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</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">division</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</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> </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">"Region 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">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</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.1/divisions/:division_name/regions</strong></dt>
+<dd><p class="first">Create Region</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p>division_name - The name of division to create new region into.</p>
+<p>** Request Route Parameters**</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">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">division_name</span></code></td>
+<td>yes</td>
+<td>The name of division will create new region in</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="14%" />
+<col width="59%" />
+</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 region</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">"myregion1"</span><span class="p">,</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="27%" />
+<col width="11%" />
+<col width="61%" />
+</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>name of region created</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>id of region created</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>the division name the region belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionId</span></code></td>
+<td>string</td>
+<td>the id of division the region belongs to.</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="s1">'divisionName'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span>
+ <span class="s1">'divsionId'</span><span class="p">:</span> <span class="s1">'4'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'19'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/role.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/role.html b/docs/1.7.0/development/traffic_ops_api/v11/role.html
index 524b240..0c3cab6 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/role.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/role.html
@@ -227,13 +227,13 @@
</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">"name"</span><span class="p">:</span> <span class="s">"read-only"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"privLevel"</span><span class="p">:</span> <span class="s">"10"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"read-only user"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"read-only"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"privLevel"</span><span class="p">:</span> <span class="s2">"10"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"read-only user"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
[40/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/cachegroup.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/cachegroup.html b/docs/1.7.0/development/traffic_ops_api/v11/cachegroup.html
index 722c4d2..c5655d8 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/cachegroup.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/cachegroup.html
@@ -190,16 +190,16 @@
<span id="to-api-v11-cachegroup"></span><h1>Cache Group<a class="headerlink" href="#cache-group" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-cachegroups">
<span id="to-api-v11-cachegroups-route"></span><h2>/api/1.1/cachegroups<a class="headerlink" href="#api-1-1-cachegroups" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cachegroups.json</strong></p>
+<p><strong>GET /api/1.1/cachegroups</strong></p>
<blockquote>
<div><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="23%" />
-<col width="8%" />
-<col width="70%" />
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -208,70 +208,86 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>Longitude for the Cache Group</td>
+<td>Local unique identifier for the Cache Group</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
-<td>Identifier that refers to the ‘id’ field of different Cache Group entry.</td>
+<td>The Time / Date this entry was last updated</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
<td>string</td>
-<td>The Time / Date this entry was last updated</td>
+<td>Latitude for the Cache Group</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
<td>string</td>
-<td>The name of the type of Cache Group entry</td>
+<td>Longitude for the Cache Group</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The name of the Cache Group entry</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
<td>string</td>
-<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+<td>Parent cachegroup ID.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td>
<td>string</td>
-<td>Latitude for the Cache Group</td>
+<td>Parent cachegroup name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
<td>string</td>
-<td>Local unique identifier for the Cache Group</td>
+<td>Secondary parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>Abbreviation of the Cache Group Name</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</td>
+</tr>
</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">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:32:03"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dccmc"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago-1"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -281,7 +297,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cachegroups/trimmed.json</strong></p>
+<p><strong>GET /api/1.1/cachegroups/trimmed</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -306,23 +322,116 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "name": "dc-chicago"
- },
- {
- "name": "dc-cmc"
- }
- ],
-}
+<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">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</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.1/cachegroups/:id</strong></p>
+<blockquote>
+<div><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="30%" />
+<col width="7%" />
+<col width="63%" />
+</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>Local unique identifier for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
+<td>string</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
+<td>string</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
+<td>string</td>
+<td>Parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td>
+<td>string</td>
+<td>Parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</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">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</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.1/cachegroup/:parameter_id/parameter.json</strong></p>
+<p><strong>GET /api/1.1/cachegroup/:parameter_id/parameter</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -375,16 +484,16 @@
</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">"cachegroups"</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="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -392,7 +501,7 @@
</pre></div>
</div>
</div></blockquote>
-<p><strong>GET /api/1.1/cachegroupparameters.json</strong></p>
+<p><strong>GET /api/1.1/cachegroupparameters</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -429,23 +538,23 @@
</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">"cachegroupParameters"</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="s2">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"380"</span><span class="p">,</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"380"</span><span class="p">,</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -456,7 +565,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cachegroups/:parameter_id/parameter/available.json</strong></p>
+<p><strong>GET /api/1.1/cachegroups/:parameter_id/parameter/available</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -505,15 +614,15 @@
</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">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</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/1.7.0/development/traffic_ops_api/v11/cdn.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/cdn.html b/docs/1.7.0/development/traffic_ops_api/v11/cdn.html
index f984c91..8b4ec50 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/cdn.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/cdn.html
@@ -190,16 +190,16 @@
<span id="to-api-v11-cdn-health"></span><h1>CDN<a class="headerlink" href="#cdn" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-cdns">
<span id="to-api-v11-cdn-health-route"></span><h2>/api/1.1/cdns<a class="headerlink" href="#api-1-1-cdns" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns.json</strong></p>
+<p><strong>GET /api/1.1/cdns</strong></p>
<blockquote>
<div><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="24%" />
+<col width="25%" />
<col width="11%" />
-<col width="65%" />
+<col width="64%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -208,22 +208,38 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>CDN name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>int</td>
-<td>CDN id.</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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-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">"name"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="mi">1</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">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">true</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>
@@ -233,16 +249,36 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cdns/name/:name.json</strong></p>
+<p><strong>GET /api/1.1/cdns/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>CDN id.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="24%" />
+<col width="25%" />
<col width="11%" />
-<col width="65%" />
+<col width="64%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -251,22 +287,105 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>CDN name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>int</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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">"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">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cdns/name/:name</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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>CDN name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</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>CDN id.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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-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">"name"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="mi">1</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">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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>
@@ -279,7 +398,7 @@
</div>
<div class="section" id="health">
<h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/health.json</strong></p>
+<p><strong>GET /api/1.1/cdns/health</strong></p>
<blockquote>
<div><p>Retrieves the health of all locations (cache groups) for all CDNs.</p>
<p>Authentication Required: Yes</p>
@@ -326,20 +445,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -350,7 +469,7 @@ group.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cdns/:name/health.json</strong></p>
+<p><strong>GET /api/1.1/cdns/:name/health</strong></p>
<blockquote>
<div><p>Retrieves the health of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -419,20 +538,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -443,7 +562,7 @@ group.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cdns/usage/overview.json</strong></p>
+<p><strong>GET /api/1.1/cdns/usage/overview</strong></p>
<blockquote>
<div><p>Retrieves the high-level CDN usage metrics.</p>
<p>Authentication Required: Yes</p>
@@ -477,17 +596,17 @@ group.</td>
</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">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
- <span class="s">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
- <span class="s">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</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">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
+ <span class="s2">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
+ <span class="s2">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
-<p><strong>GET /api/1.1/cdns/capacity.json</strong></p>
+<p><strong>GET /api/1.1/cdns/capacity</strong></p>
<blockquote>
<div><p>Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -525,12 +644,12 @@ group.</td>
</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -542,7 +661,7 @@ group.</td>
</div>
<div class="section" id="routing">
<span id="to-api-v11-cdn-routing"></span><h2>Routing<a class="headerlink" href="#routing" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/routing.json</strong></p>
+<p><strong>GET /api/1.1/cdns/routing</strong></p>
<blockquote>
<div><p>Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -588,14 +707,14 @@ group.</td>
</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -607,7 +726,7 @@ group.</td>
</div>
<div class="section" id="metrics">
<span id="to-api-v11-cdn-metrics"></span><h2>Metrics<a class="headerlink" href="#metrics" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end.json</strong></p>
+<p><strong>GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end</strong></p>
<blockquote>
<div><p>Retrieves edge metrics of one or all locations (cache groups).</p>
<p>Authentication Required: Yes</p>
@@ -709,20 +828,20 @@ group.</td>
</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">"stats"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
- <span class="s">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
+ <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
<span class="p">},</span>
- <span class="s">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
<span class="mi">1425135900000</span><span class="p">,</span>
<span class="mf">1668.03</span>
@@ -732,7 +851,7 @@ group.</td>
<span class="n">null</span>
<span class="p">]</span>
<span class="p">],</span>
- <span class="s">"label"</span><span class="p">:</span> <span class="s">"Origin TPS"</span>
+ <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"Origin TPS"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -745,7 +864,7 @@ group.</td>
</div>
<div class="section" id="domains">
<span id="to-api-v11-cdn-domains"></span><h2>Domains<a class="headerlink" href="#domains" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/domains.json</strong></p>
+<p><strong>GET /api/1.1/cdns/domains</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -786,21 +905,21 @@ group.</td>
</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">"profileId"</span><span class="p">:</span> <span class="s">"5"</span><span class="p">,</span>
- <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"404"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_FOO"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for foo.domain.net"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"foo.domain.net"</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"404"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_FOO"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for foo.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"foo.domain.net"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
- <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"405"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_BAR"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for bar.domain.net"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"bar.domain.net"</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"405"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_BAR"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for bar.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"bar.domain.net"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -813,7 +932,7 @@ group.</td>
</div>
<div class="section" id="topology">
<span id="to-api-v11-cdn-topology"></span><h2>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/:cdn_name/configs.json</strong></p>
+<p><strong>GET /api/1.1/cdns/:cdn_name/configs</strong></p>
<blockquote>
<div><p>Retrieves CDN config information based upon the provided cdn name.</p>
<p>Authentication Required: Yes</p>
@@ -871,14 +990,14 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cdns/:name/configs/monitoring.json</strong></p>
+<p><strong>GET /api/1.1/cdns/:name/configs/monitoring</strong></p>
<blockquote>
<div><p>Retrieves CDN monitoring information.</p>
<p>Authentication Required: Yes</p>
@@ -1133,14 +1252,14 @@ profiles.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cdns/:name/configs/routing.json</strong></p>
+<p><strong>GET /api/1.1/cdns/:name/configs/routing</strong></p>
<blockquote>
<div><p>Retrieves CDN routing information.</p>
<p>Authentication Required: Yes</p>
@@ -1555,7 +1674,7 @@ services.</td>
</div>
<div class="section" id="dnssec-keys">
<span id="to-api-v11-cdn-dnsseckeys"></span><h2>DNSSEC Keys<a class="headerlink" href="#dnssec-keys" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/name/:name/dnsseckeys.json</strong></p>
+<p><strong>GET /api/1.1/cdns/name/:name/dnsseckeys</strong></p>
<blockquote>
<div><p>Gets a list of dnsseckeys for CDN and all associated Delivery Services.
Before returning response to user, check to make sure keys aren’t expired. If they are expired, generate new ones.
@@ -1635,53 +1754,53 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": {
- "cdn1": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "foo.kabletown.com."
- },
- "ksk": {
- "name": "foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750",
- "ttl": "60"
- }
- },
- "ds-01": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "ds-01.foo.kabletown.com."
- },
- "ksk": {
- "name": "ds-01.foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750"
- }
- },
- ... repeated for each ds in the cdn
- },
-}
+<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">"cdn1"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s2">"ds-01"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="o">...</span> <span class="n">repeated</span> <span class="k">for</span> <span class="n">each</span> <span class="n">ds</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">cdn</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.1/cdns/name/:name/dnsseckeys/delete.json</strong></p>
+<p><strong>GET /api/1.1/cdns/name/:name/dnsseckeys/delete</strong></p>
<blockquote>
<div><p>Delete dnssec keys for a cdn and all associated delivery services.</p>
<p>Authentication Required: Yes</p>
@@ -1727,8 +1846,8 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</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="s">"Successfully deleted dnssec keys for <cdn>"</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="s2">"Successfully deleted dnssec keys for <cdn>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1778,13 +1897,13 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "key": "cdn1",
- "name" "ott.kabletown.com",
- "ttl": "60",
- "kskExpirationDays": "365",
- "zskExpirationDays": "90"
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"cdn1"</span><span class="p">,</span>
+ <span class="s2">"name"</span> <span class="s2">"ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"kskExpirationDays"</span><span class="p">:</span> <span class="s2">"365"</span><span class="p">,</span>
+ <span class="s2">"zskExpirationDays"</span><span class="p">:</span> <span class="s2">"90"</span>
+<span class="p">}</span>
</pre></div>
</div>
<p><strong>Response Properties</strong></p>
@@ -1812,8 +1931,8 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</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="s">"Successfully created dnssec keys for cdn1"</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="s2">"Successfully created dnssec keys for cdn1"</span>
<span class="p">}</span>
</pre></div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/changelog.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/changelog.html b/docs/1.7.0/development/traffic_ops_api/v11/changelog.html
index 638a4dc..efd8cd7 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/changelog.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/changelog.html
@@ -235,23 +235,23 @@
</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">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
<span class="p">},</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -326,23 +326,23 @@
</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">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -377,9 +377,9 @@
</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">"newLogcount"</span><span class="p">:</span> <span class="mi">0</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">"newLogcount"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
[43/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/traffic_ops_extensions.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/traffic_ops_extensions.html b/docs/1.7.0/admin/traffic_ops_extensions.html
index b90a686..c894f91 100644
--- a/docs/1.7.0/admin/traffic_ops_extensions.html
+++ b/docs/1.7.0/admin/traffic_ops_extensions.html
@@ -105,7 +105,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
@@ -190,7 +190,7 @@
<p>The extensions must be registered with Traffic Ops in order to display a column on the Server Check page. The list of currently registered extensions can be listed by running <code class="docutils literal"><span class="pre">/opt/traffic_ops/app/bin/extensions</span> <span class="pre">-a</span></code>.</p>
<p>The below extensions are automatically registered with the Traffic Ops database (<code class="docutils literal"><span class="pre">to_extension</span></code> table) at install time (see <code class="docutils literal"><span class="pre">traffic_ops/app/db/seeds.sql</span></code>). However, cron must still be configured to run these checks periodically.</p>
<p>The scripts are called as follows:</p>
-<div class="highlight-python"><div class="highlight"><pre>$TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
+<div class="highlight-default"><div class="highlight"><pre><span></span>$TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
where:
<name> is the type of check script
@@ -202,48 +202,48 @@ where:
<div class="section" id="example-cron-file">
<h2>Example Cron File<a class="headerlink" href="#example-cron-file" title="Permalink to this headline">�</a></h2>
<p>Edit with <code class="docutils literal"><span class="pre">crontab</span> <span class="pre">-e</span></code>. You may need to adjust the path to your $TO_HOME to match your system.</p>
-<div class="highlight-python"><div class="highlight"><pre>PERL5LIB=/opt/traffic_ops/app/local/lib/perl5:/opt/traffic_ops/app/lib
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span>
-# IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": [\"hostName\",\"domainName\"]}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"name\": \"IPv4 Ping\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: [</span><span class="se">\"</span><span class="s2">hostName</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">domainName</span><span class="se">\"</span><span class="s2">]}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">IPv4 Ping</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</s
pan><span class="o">>&</span><span class="mi">1</span>
-# IPv6 ping examples
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"name\": \"IPv6 Ping\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+<span class="c1"># IPv6 ping examples</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G6</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">IPv6 Ping</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">&g
t;&</span><span class="mi">1</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G6</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-# iLO ping
-18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"select\": \"iloIpAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"name\": \"ILO ping\", \"select\": \"iloIpAddress\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
+<span class="c1"># iLO ping</span>
+<span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">ILO</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">iloIpAddress</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">ILO</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ILO ping</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">iloIpAddress</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class
="mi">1</span>
-# MTU ping
-45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># MTU ping</span>
+<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Max Trans Unit</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o"
>>&</span><span class="mi">1</span>
+<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Max Trans Unit</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o
">>&</span><span class="mi">1</span>
-# FQDN
-27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\"" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\", \"name\": \"DNS Lookup\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># FQDN</span>
+<span class="mi">27</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToFQDNCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">FQDN</span><span class="se">\"</span><span class="s2">"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">27</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToFQDNCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">FQDN</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">DNS Lookup</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-# DSCP
-36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"cms_interface\": \"eth0\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"name\": \"Delivery Service\", \"cms_interface\": \"eth0\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># DSCP</span>
+<span class="mi">36</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToDSCPCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">DSCP</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">cms_interface</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">eth0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">36</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToDSCPCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">DSCP</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Delivery Service</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">cms_interface</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">eth0</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class
="o">>&</span><span class="mi">1</span>
-# RTR
-10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\", \"name\": \"Content Router Check\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># RTR</span>
+<span class="mi">10</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToRTRCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&quo
t;</span><span class="s2">RTR</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">10</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToRTRCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&quo
t;</span><span class="s2">RTR</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Content Router Check</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-# CHR
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToCHRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CHR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+<span class="c1"># CHR</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToCHRCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </sp
an><span class="se">\"</span><span class="s2">CHR</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-# CDU
-20 * * * * root /opt/traffic_ops/app/bin/checks/ToCDUCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CDU\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+<span class="c1"># CDU</span>
+<span class="mi">20</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToCDUCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&quo
t;</span><span class="s2">CDU</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-# ORT
-40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\", \"name\": \"Operational Readiness Test\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># ORT</span>
+<span class="mi">40</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">ssh_key_edge_user</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToORTCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span cla
ss="se">\"</span><span class="s2">ORT</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">40</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">ssh_key_edge_user</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToORTCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span cla
ss="se">\"</span><span class="s2">ORT</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Operational Readiness Test</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
</pre></div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/traffic_ops_install.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/traffic_ops_install.html b/docs/1.7.0/admin/traffic_ops_install.html
index 03ffa96..a3ed616 100644
--- a/docs/1.7.0/admin/traffic_ops_install.html
+++ b/docs/1.7.0/admin/traffic_ops_install.html
@@ -102,7 +102,7 @@
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="">Installing Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
@@ -254,13 +254,13 @@
</ol>
<blockquote>
<div><p>Example output:</p>
-<div class="highlight-python"><div class="highlight"><pre>trafficops-vm # /opt/traffic_ops/install/bin/postinstall
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">trafficops</span><span class="o">-</span><span class="n">vm</span> <span class="c1"># /opt/traffic_ops/install/bin/postinstall</span>
-This script will build and package the required Traffic Ops perl modules.
-In order to complete this operation, Development tools such as the gcc
-compiler must be installed on this machine.
+<span class="n">This</span> <span class="n">script</span> <span class="n">will</span> <span class="n">build</span> <span class="ow">and</span> <span class="n">package</span> <span class="n">the</span> <span class="n">required</span> <span class="n">Traffic</span> <span class="n">Ops</span> <span class="n">perl</span> <span class="n">modules</span><span class="o">.</span>
+<span class="n">In</span> <span class="n">order</span> <span class="n">to</span> <span class="n">complete</span> <span class="n">this</span> <span class="n">operation</span><span class="p">,</span> <span class="n">Development</span> <span class="n">tools</span> <span class="n">such</span> <span class="k">as</span> <span class="n">the</span> <span class="n">gcc</span>
+<span class="n">compiler</span> <span class="n">must</span> <span class="n">be</span> <span class="n">installed</span> <span class="n">on</span> <span class="n">this</span> <span class="n">machine</span><span class="o">.</span>
-Hit ENTER to continue:
+<span class="n">Hit</span> <span class="n">ENTER</span> <span class="n">to</span> <span class="k">continue</span><span class="p">:</span>
</pre></div>
</div>
<p>The first thing the post install will do is install additional packages needed from the yum repo.</p>
@@ -271,7 +271,7 @@ Hit ENTER to continue:
</div>
<p>If there are any prompts in this phase, please just answer with the defaults (some CPAN installs can prompt for install questions).</p>
<p>When this phase is complete, you will see:</p>
-<div class="highlight-python"><div class="highlight"><pre>...
+<div class="highlight-default"><div class="highlight"><pre><span></span>...
Successfully installed Test-Differences-0.63
Successfully installed DBIx-Class-Schema-Loader-0.07042
Successfully installed Time-HiRes-1.9726 (upgraded from 1.9719)
@@ -300,7 +300,7 @@ Database type [mysql]:
<p class="last">CentOS files note.</p>
</div>
<p>Example output:</p>
-<div class="highlight-python"><div class="highlight"><pre>Database type [mysql]:
+<div class="highlight-default"><div class="highlight"><pre><span></span>Database type [mysql]:
Database name [traffic_ops_db]:
Database server hostname IP or FQDN [localhost]:
Database port number [3306]:
@@ -426,7 +426,7 @@ seeding parameter data...
<td>The DNS domain that will be delegated to this Traffic Control CDN</td>
</tr>
<tr class="row-odd"><td>name of your CentOS 6.5 ISO kickstart tar file</td>
-<td>See <a class="reference internal" href="traffic_ops_config.html#creating-centos-kickstart"><em>Creating the CentOS Kickstart File</em></a></td>
+<td>See <a class="reference internal" href="traffic_ops_config.html#creating-centos-kickstart"><span class="std std-ref">Creating the CentOS Kickstart File</span></a></td>
</tr>
<tr class="row-even"><td>Administration username for Traffic Ops</td>
<td>The Administration (highest privilege) Traffic Ops user to create;
@@ -441,120 +441,120 @@ use this user to login for the first time and create other users</td>
<p>The postinstall script will now seed the database with some inital configuration settings for the CDN and the servers in the CDN.</p>
<p>The next phase is the download of the geo location database and configuration of information needed for SSL certificates.</p>
<p>Example output:</p>
-<div class="highlight-python"><div class="highlight"><pre>Downloading MaxMind data.
---2015-04-14 02:14:32-- http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
-Resolving geolite.maxmind.com... 141.101.115.190, 141.101.114.190, 2400:cb00:2048:1::8d65:73be, ...
-Connecting to geolite.maxmind.com|141.101.115.190|:80... connected.
-HTTP request sent, awaiting response... 200 OK
-Length: 17633433 (17M) [application/octet-stream]
-Saving to: "GeoLite2-City.mmdb.gz"
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Downloading</span> <span class="n">MaxMind</span> <span class="n">data</span><span class="o">.</span>
+<span class="o">--</span><span class="mi">2015</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">14</span> <span class="mi">02</span><span class="p">:</span><span class="mi">14</span><span class="p">:</span><span class="mi">32</span><span class="o">--</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">geolite</span><span class="o">.</span><span class="n">maxmind</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">download</span><span class="o">/</span><span class="n">geoip</span><span class="o">/</span><span class="n">database</span><span class="o">/</span><span class="n">GeoLite2</span><span class="o">-</span><span class="n">City</span><span class="o">.</span><span class="n">mmdb</span><span class="o">.</span><span class="n">gz</span>
+<span class="n">Resolving</span> <span class="n">geolite</span><span class="o">.</span><span class="n">maxmind</span><span class="o">.</span><span class="n">com</span><span class="o">...</span> <span class="mf">141.101</span><span class="o">.</span><span class="mf">115.190</span><span class="p">,</span> <span class="mf">141.101</span><span class="o">.</span><span class="mf">114.190</span><span class="p">,</span> <span class="mi">2400</span><span class="p">:</span><span class="n">cb00</span><span class="p">:</span><span class="mi">2048</span><span class="p">:</span><span class="mi">1</span><span class="p">::</span><span class="mi">8</span><span class="n">d65</span><span class="p">:</span><span class="mi">73</span><span class="n">be</span><span class="p">,</span> <span class="o">...</span>
+<span class="n">Connecting</span> <span class="n">to</span> <span class="n">geolite</span><span class="o">.</span><span class="n">maxmind</span><span class="o">.</span><span class="n">com</span><span class="o">|</span><span class="mf">141.101</span><span class="o">.</span><span class="mf">115.190</span><span class="o">|</span><span class="p">:</span><span class="mf">80.</span><span class="o">..</span> <span class="n">connected</span><span class="o">.</span>
+<span class="n">HTTP</span> <span class="n">request</span> <span class="n">sent</span><span class="p">,</span> <span class="n">awaiting</span> <span class="n">response</span><span class="o">...</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Length</span><span class="p">:</span> <span class="mi">17633433</span> <span class="p">(</span><span class="mi">17</span><span class="n">M</span><span class="p">)</span> <span class="p">[</span><span class="n">application</span><span class="o">/</span><span class="n">octet</span><span class="o">-</span><span class="n">stream</span><span class="p">]</span>
+<span class="n">Saving</span> <span class="n">to</span><span class="p">:</span> <span class="s2">"GeoLite2-City.mmdb.gz"</span>
-100%[==================================================================================================================================================================>] 17,633,433 7.03M/s in 2.4s
+<span class="mi">100</span><span class="o">%</span><span class="p">[</span><span class="o">==================================================================================================================================================================></span><span class="p">]</span> <span class="mi">17</span><span class="p">,</span><span class="mi">633</span><span class="p">,</span><span class="mi">433</span> <span class="mf">7.03</span><span class="n">M</span><span class="o">/</span><span class="n">s</span> <span class="ow">in</span> <span class="mf">2.4</span><span class="n">s</span>
-2015-04-14 02:14:35 (7.03 MB/s) - "GeoLite2-City.mmdb.gz" saved [17633433/17633433]
+<span class="mi">2015</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">14</span> <span class="mi">02</span><span class="p">:</span><span class="mi">14</span><span class="p">:</span><span class="mi">35</span> <span class="p">(</span><span class="mf">7.03</span> <span class="n">MB</span><span class="o">/</span><span class="n">s</span><span class="p">)</span> <span class="o">-</span> <span class="s2">"GeoLite2-City.mmdb.gz"</span> <span class="n">saved</span> <span class="p">[</span><span class="mi">17633433</span><span class="o">/</span><span class="mi">17633433</span><span class="p">]</span>
-Copying coverage zone file to public dir.
+<span class="n">Copying</span> <span class="n">coverage</span> <span class="n">zone</span> <span class="n">file</span> <span class="n">to</span> <span class="n">public</span> <span class="nb">dir</span><span class="o">.</span>
-Installing SSL Certificates.
+<span class="n">Installing</span> <span class="n">SSL</span> <span class="n">Certificates</span><span class="o">.</span>
- We're now running a script to generate a self signed X509 SSL certificate.
- When prompted to enter a pass phrase, just enter 'pass' each time. The
- pass phrase will be stripped from the private key before installation.
+ <span class="n">We</span><span class="s1">'re now running a script to generate a self signed X509 SSL certificate.</span>
+ <span class="n">When</span> <span class="n">prompted</span> <span class="n">to</span> <span class="n">enter</span> <span class="n">a</span> <span class="k">pass</span> <span class="n">phrase</span><span class="p">,</span> <span class="n">just</span> <span class="n">enter</span> <span class="s1">'pass'</span> <span class="n">each</span> <span class="n">time</span><span class="o">.</span> <span class="n">The</span>
+ <span class="k">pass</span> <span class="n">phrase</span> <span class="n">will</span> <span class="n">be</span> <span class="n">stripped</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">private</span> <span class="n">key</span> <span class="n">before</span> <span class="n">installation</span><span class="o">.</span>
- When prompted to enter a 'challenge password', just hit the ENTER key.
+ <span class="n">When</span> <span class="n">prompted</span> <span class="n">to</span> <span class="n">enter</span> <span class="n">a</span> <span class="s1">'challenge password'</span><span class="p">,</span> <span class="n">just</span> <span class="n">hit</span> <span class="n">the</span> <span class="n">ENTER</span> <span class="n">key</span><span class="o">.</span>
- The remaining enformation Country, State, Locality, etc... are required to
- generate a properly formatted SSL certificate.
+ <span class="n">The</span> <span class="n">remaining</span> <span class="n">enformation</span> <span class="n">Country</span><span class="p">,</span> <span class="n">State</span><span class="p">,</span> <span class="n">Locality</span><span class="p">,</span> <span class="n">etc</span><span class="o">...</span> <span class="n">are</span> <span class="n">required</span> <span class="n">to</span>
+ <span class="n">generate</span> <span class="n">a</span> <span class="n">properly</span> <span class="n">formatted</span> <span class="n">SSL</span> <span class="n">certificate</span><span class="o">.</span>
-Hit Enter when you are ready to continue:
-Postinstall SSL Certificate Creation.
+<span class="n">Hit</span> <span class="n">Enter</span> <span class="n">when</span> <span class="n">you</span> <span class="n">are</span> <span class="n">ready</span> <span class="n">to</span> <span class="k">continue</span><span class="p">:</span>
+<span class="n">Postinstall</span> <span class="n">SSL</span> <span class="n">Certificate</span> <span class="n">Creation</span><span class="o">.</span>
-Generating an RSA Private Server Key.
+<span class="n">Generating</span> <span class="n">an</span> <span class="n">RSA</span> <span class="n">Private</span> <span class="n">Server</span> <span class="n">Key</span><span class="o">.</span>
-Generating RSA private key, 1024 bit long modulus
-..........................++++++
-.....................++++++
-e is 65537 (0x10001)
-Enter pass phrase for server.key:
-Verifying - Enter pass phrase for server.key:
+<span class="n">Generating</span> <span class="n">RSA</span> <span class="n">private</span> <span class="n">key</span><span class="p">,</span> <span class="mi">1024</span> <span class="n">bit</span> <span class="n">long</span> <span class="n">modulus</span>
+<span class="o">..........................++++++</span>
+<span class="o">.....................++++++</span>
+<span class="n">e</span> <span class="ow">is</span> <span class="mi">65537</span> <span class="p">(</span><span class="mh">0x10001</span><span class="p">)</span>
+<span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="p">:</span>
+<span class="n">Verifying</span> <span class="o">-</span> <span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="p">:</span>
-The server key has been generated.
+<span class="n">The</span> <span class="n">server</span> <span class="n">key</span> <span class="n">has</span> <span class="n">been</span> <span class="n">generated</span><span class="o">.</span>
-Creating a Certificate Signing Request (CSR)
+<span class="n">Creating</span> <span class="n">a</span> <span class="n">Certificate</span> <span class="n">Signing</span> <span class="n">Request</span> <span class="p">(</span><span class="n">CSR</span><span class="p">)</span>
-Enter pass phrase for server.key:
-You are about to be asked to enter information that will be incorporated
-into your certificate request.
-What you are about to enter is what is called a Distinguished Name or a DN.
-There are quite a few fields but you can leave some blank
-For some fields there will be a default value,
-If you enter '.', the field will be left blank.
------
-Country Name (2 letter code) [XX]:US
-State or Province Name (full name) []:CO
-Locality Name (eg, city) [Default City]:Denver
-Organization Name (eg, company) [Default Company Ltd]:
-Organizational Unit Name (eg, section) []:
-Common Name (eg, your name or your server's hostname) []:
-Email Address []:
+<span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="p">:</span>
+<span class="n">You</span> <span class="n">are</span> <span class="n">about</span> <span class="n">to</span> <span class="n">be</span> <span class="n">asked</span> <span class="n">to</span> <span class="n">enter</span> <span class="n">information</span> <span class="n">that</span> <span class="n">will</span> <span class="n">be</span> <span class="n">incorporated</span>
+<span class="n">into</span> <span class="n">your</span> <span class="n">certificate</span> <span class="n">request</span><span class="o">.</span>
+<span class="n">What</span> <span class="n">you</span> <span class="n">are</span> <span class="n">about</span> <span class="n">to</span> <span class="n">enter</span> <span class="ow">is</span> <span class="n">what</span> <span class="ow">is</span> <span class="n">called</span> <span class="n">a</span> <span class="n">Distinguished</span> <span class="n">Name</span> <span class="ow">or</span> <span class="n">a</span> <span class="n">DN</span><span class="o">.</span>
+<span class="n">There</span> <span class="n">are</span> <span class="n">quite</span> <span class="n">a</span> <span class="n">few</span> <span class="n">fields</span> <span class="n">but</span> <span class="n">you</span> <span class="n">can</span> <span class="n">leave</span> <span class="n">some</span> <span class="n">blank</span>
+<span class="n">For</span> <span class="n">some</span> <span class="n">fields</span> <span class="n">there</span> <span class="n">will</span> <span class="n">be</span> <span class="n">a</span> <span class="n">default</span> <span class="n">value</span><span class="p">,</span>
+<span class="n">If</span> <span class="n">you</span> <span class="n">enter</span> <span class="s1">'.'</span><span class="p">,</span> <span class="n">the</span> <span class="n">field</span> <span class="n">will</span> <span class="n">be</span> <span class="n">left</span> <span class="n">blank</span><span class="o">.</span>
+<span class="o">-----</span>
+<span class="n">Country</span> <span class="n">Name</span> <span class="p">(</span><span class="mi">2</span> <span class="n">letter</span> <span class="n">code</span><span class="p">)</span> <span class="p">[</span><span class="n">XX</span><span class="p">]:</span><span class="n">US</span>
+<span class="n">State</span> <span class="ow">or</span> <span class="n">Province</span> <span class="n">Name</span> <span class="p">(</span><span class="n">full</span> <span class="n">name</span><span class="p">)</span> <span class="p">[]:</span><span class="n">CO</span>
+<span class="n">Locality</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">city</span><span class="p">)</span> <span class="p">[</span><span class="n">Default</span> <span class="n">City</span><span class="p">]:</span><span class="n">Denver</span>
+<span class="n">Organization</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">company</span><span class="p">)</span> <span class="p">[</span><span class="n">Default</span> <span class="n">Company</span> <span class="n">Ltd</span><span class="p">]:</span>
+<span class="n">Organizational</span> <span class="n">Unit</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">section</span><span class="p">)</span> <span class="p">[]:</span>
+<span class="n">Common</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">your</span> <span class="n">name</span> <span class="ow">or</span> <span class="n">your</span> <span class="n">server</span><span class="s1">'s hostname) []:</span>
+<span class="n">Email</span> <span class="n">Address</span> <span class="p">[]:</span>
-Please enter the following 'extra' attributes
-to be sent with your certificate request
-A challenge password []:pass
-An optional company name []:
+<span class="n">Please</span> <span class="n">enter</span> <span class="n">the</span> <span class="n">following</span> <span class="s1">'extra'</span> <span class="n">attributes</span>
+<span class="n">to</span> <span class="n">be</span> <span class="n">sent</span> <span class="k">with</span> <span class="n">your</span> <span class="n">certificate</span> <span class="n">request</span>
+<span class="n">A</span> <span class="n">challenge</span> <span class="n">password</span> <span class="p">[]:</span><span class="k">pass</span>
+<span class="n">An</span> <span class="n">optional</span> <span class="n">company</span> <span class="n">name</span> <span class="p">[]:</span>
-The Certificate Signing Request has been generated.
-Removing the pass phrase from the server key.
-Enter pass phrase for server.key.orig:
-writing RSA key
+<span class="n">The</span> <span class="n">Certificate</span> <span class="n">Signing</span> <span class="n">Request</span> <span class="n">has</span> <span class="n">been</span> <span class="n">generated</span><span class="o">.</span>
+<span class="n">Removing</span> <span class="n">the</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">server</span> <span class="n">key</span><span class="o">.</span>
+<span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">orig</span><span class="p">:</span>
+<span class="n">writing</span> <span class="n">RSA</span> <span class="n">key</span>
-The pass phrase has been removed from the server key.
+<span class="n">The</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="n">has</span> <span class="n">been</span> <span class="n">removed</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">server</span> <span class="n">key</span><span class="o">.</span>
-Generating a Self-signed certificate.
-Signature ok
-subject=/C=US/ST=CO/L=Denver/O=Default Company Ltd
-Getting Private key
+<span class="n">Generating</span> <span class="n">a</span> <span class="n">Self</span><span class="o">-</span><span class="n">signed</span> <span class="n">certificate</span><span class="o">.</span>
+<span class="n">Signature</span> <span class="n">ok</span>
+<span class="n">subject</span><span class="o">=/</span><span class="n">C</span><span class="o">=</span><span class="n">US</span><span class="o">/</span><span class="n">ST</span><span class="o">=</span><span class="n">CO</span><span class="o">/</span><span class="n">L</span><span class="o">=</span><span class="n">Denver</span><span class="o">/</span><span class="n">O</span><span class="o">=</span><span class="n">Default</span> <span class="n">Company</span> <span class="n">Ltd</span>
+<span class="n">Getting</span> <span class="n">Private</span> <span class="n">key</span>
-A server key and self signed certificate has been generated.
+<span class="n">A</span> <span class="n">server</span> <span class="n">key</span> <span class="ow">and</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">certificate</span> <span class="n">has</span> <span class="n">been</span> <span class="n">generated</span><span class="o">.</span>
-Installing the server key and server certificate.
+<span class="n">Installing</span> <span class="n">the</span> <span class="n">server</span> <span class="n">key</span> <span class="ow">and</span> <span class="n">server</span> <span class="n">certificate</span><span class="o">.</span>
-The private key has been installed.
+<span class="n">The</span> <span class="n">private</span> <span class="n">key</span> <span class="n">has</span> <span class="n">been</span> <span class="n">installed</span><span class="o">.</span>
-Installing the self signed certificate.
+<span class="n">Installing</span> <span class="n">the</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">certificate</span><span class="o">.</span>
-Saving the self signed csr.
+<span class="n">Saving</span> <span class="n">the</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">csr</span><span class="o">.</span>
- The self signed certificate has now been installed.
+ <span class="n">The</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">certificate</span> <span class="n">has</span> <span class="n">now</span> <span class="n">been</span> <span class="n">installed</span><span class="o">.</span>
- You may obtain a certificate signed by a Certificate Authority using the
- server.csr file saved in the current directory. Once you have obtained
- a signed certificate, copy it to /etc/pki/tls/certs/localhost.crt and
- restart Traffic Ops.
+ <span class="n">You</span> <span class="n">may</span> <span class="n">obtain</span> <span class="n">a</span> <span class="n">certificate</span> <span class="n">signed</span> <span class="n">by</span> <span class="n">a</span> <span class="n">Certificate</span> <span class="n">Authority</span> <span class="n">using</span> <span class="n">the</span>
+ <span class="n">server</span><span class="o">.</span><span class="n">csr</span> <span class="n">file</span> <span class="n">saved</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">current</span> <span class="n">directory</span><span class="o">.</span> <span class="n">Once</span> <span class="n">you</span> <span class="n">have</span> <span class="n">obtained</span>
+ <span class="n">a</span> <span class="n">signed</span> <span class="n">certificate</span><span class="p">,</span> <span class="n">copy</span> <span class="n">it</span> <span class="n">to</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">pki</span><span class="o">/</span><span class="n">tls</span><span class="o">/</span><span class="n">certs</span><span class="o">/</span><span class="n">localhost</span><span class="o">.</span><span class="n">crt</span> <span class="ow">and</span>
+ <span class="n">restart</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="o">.</span>
-SSL Certificates have been installed.
+<span class="n">SSL</span> <span class="n">Certificates</span> <span class="n">have</span> <span class="n">been</span> <span class="n">installed</span><span class="o">.</span>
-Starting Traffic Ops.
+<span class="n">Starting</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="o">.</span>
-Starting Traffic Ops
+<span class="n">Starting</span> <span class="n">Traffic</span> <span class="n">Ops</span>
-Subroutine TrafficOps::has redefined at /opt/traffic_ops/app/local/lib/perl5/Mojo/Base.pm line 38.
-Subroutine TrafficOps::has redefined at /opt/traffic_ops/app/local/lib/perl5/Mojo/Base.pm line 38.
-Loading config from /opt/traffic_ops/app/conf/cdn.conf
-Reading log4perl config from /opt/traffic_ops/app/conf/production/log4perl.conf
-Starting hot deployment for Hypnotoad server 32192.
+<span class="n">Subroutine</span> <span class="n">TrafficOps</span><span class="p">::</span><span class="n">has</span> <span class="n">redefined</span> <span class="n">at</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="o">/</span><span class="n">Mojo</span><span class="o">/</span><span class="n">Base</span><span class="o">.</span><span class="n">pm</span> <span class="n">line</span> <span class="mf">38.</span>
+<span class="n">Subroutine</span> <span class="n">TrafficOps</span><span class="p">::</span><span class="n">has</span> <span class="n">redefined</span> <span class="n">at</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="o">/</span><span class="n">Mojo</span><span class="o">/</span><span class="n">Base</span><span class="o">.</span><span class="n">pm</span> <span class="n">line</span> <span class="mf">38.</span>
+<span class="n">Loading</span> <span class="n">config</span> <span class="kn">from</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">conf</span><span class="o">/</span><span class="n">cdn</span><span class="o">.</span><span class="n">conf</span>
+<span class="n">Reading</span> <span class="n">log4perl</span> <span class="n">config</span> <span class="kn">from</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">conf</span><span class="o">/</span><span class="n">production</span><span class="o">/</span><span class="n">log4perl</span><span class="o">.</span><span class="n">conf</span>
+<span class="n">Starting</span> <span class="n">hot</span> <span class="n">deployment</span> <span class="k">for</span> <span class="n">Hypnotoad</span> <span class="n">server</span> <span class="mf">32192.</span>
-Waiting for Traffic Ops to start.
+<span class="n">Waiting</span> <span class="k">for</span> <span class="n">Traffic</span> <span class="n">Ops</span> <span class="n">to</span> <span class="n">start</span><span class="o">.</span>
-Shutdown Traffic Ops [y/n] [n]: n
+<span class="n">Shutdown</span> <span class="n">Traffic</span> <span class="n">Ops</span> <span class="p">[</span><span class="n">y</span><span class="o">/</span><span class="n">n</span><span class="p">]</span> <span class="p">[</span><span class="n">n</span><span class="p">]:</span> <span class="n">n</span>
-To start Traffic Ops: service traffic_ops start
-To stop Traffic Ops: service traffic_ops stop
+<span class="n">To</span> <span class="n">start</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="p">:</span> <span class="n">service</span> <span class="n">traffic_ops</span> <span class="n">start</span>
+<span class="n">To</span> <span class="n">stop</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="p">:</span> <span class="n">service</span> <span class="n">traffic_ops</span> <span class="n">stop</span>
-traffic_ops #
+<span class="n">traffic_ops</span> <span class="c1">#</span>
</pre></div>
</div>
</div></blockquote>
@@ -565,7 +565,7 @@ traffic_ops #
<ol class="arabic simple">
<li>Enter the following command:<code class="docutils literal"><span class="pre">service</span> <span class="pre">traffic_ops</span> <span class="pre">stop</span></code></li>
<li>Enter the following command:<code class="docutils literal"><span class="pre">yum</span> <span class="pre">upgrade</span> <span class="pre">traffic_ops</span></code></li>
-<li>See <a class="reference internal" href="#rl-ps"><em>Installing Traffic Ops</em></a> to run the post install.</li>
+<li>See <a class="reference internal" href="#rl-ps"><span class="std std-ref">Installing Traffic Ops</span></a> to run the post install.</li>
<li>Enter the following command:<code class="docutils literal"><span class="pre">service</span> <span class="pre">traffic_ops</span> <span class="pre">start</span></code></li>
</ol>
</div>
[44/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/quick_howto/multi_site.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/quick_howto/multi_site.html b/docs/1.7.0/admin/quick_howto/multi_site.html
index 2802e65..ffc8ea1 100644
--- a/docs/1.7.0/admin/quick_howto/multi_site.html
+++ b/docs/1.7.0/admin/quick_howto/multi_site.html
@@ -191,23 +191,23 @@
<ol class="arabic simple">
<li>Create “cachegroups” for the origin locations, and assign the appropriate parent-child relationship between the mid cg’s and org cgs (click the image to see full size):</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png"><img alt="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" class="align-center" src="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" /></a>
+<a class="reference internal image-reference" href="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png"><img alt="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" class="align-center" src="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" style="width: 1472.0px; height: 210.0px;" /></a>
<ol class="arabic simple" start="2">
<li>Create a profile to assign to each of the origins:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png"><img alt="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" class="align-center" src="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" /></a>
+<a class="reference internal image-reference" href="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png"><img alt="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" class="align-center" src="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" style="width: 1470.0px; height: 219.0px;" /></a>
<ol class="arabic simple" start="3">
<li>Create server entries for the origination vips:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png"><img alt="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" class="align-center" src="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" /></a>
+<a class="reference internal image-reference" href="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png"><img alt="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" class="align-center" src="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" style="width: 1468.0px; height: 166.0px;" /></a>
<ol class="arabic simple" start="4">
<li>Check the multi-site check box in the delivery service screen and make sure that Content Routing Type is set to HTTP_LIVE_NATL:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/mso-enable.png"><img alt="../../_images/mso-enable.png" class="align-center" src="../../_images/mso-enable.png" /></a>
+<a class="reference internal image-reference" href="../../_images/mso-enable.png"><img alt="../../_images/mso-enable.png" class="align-center" src="../../_images/mso-enable.png" style="width: 1695.0px; height: 1079.0px;" /></a>
<ol class="arabic simple" start="5">
<li>Assign the org servers to the delivery service that will have the multi site feature:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png"><img alt="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" class="align-center" src="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" /></a>
+<a class="reference internal image-reference" href="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png"><img alt="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" class="align-center" src="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" style="width: 580.0px; height: 343.0px;" /></a>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">\u201cOrigin Server Base URL\u201d uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that \u201cOrigin Server Base URL\u201d (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The exceptions are:
@@ -234,7 +234,11 @@
</tr>
<tr class="row-odd"><td>Primary/back</td>
<td>Round robin selection does not occur. The first origin server is selected unless it fails.
-If the first fails, the second and other following origin servers will be tried by order.</td>
+If the first fails, the second and other following origin servers will be tried by order.
+Order is defined by 2 factors - if the origin server’s cachegroup is configured as the
+parent cachegroup for the mid, then this server will be used as the primary. The same rules
+apply for secondary parents, in order. Within the cachegroups, the rank parameter will sort
+order further. If no parents are defined at the mid, then only rank is considered.</td>
</tr>
<tr class="row-even"><td>Strict
round-robin</td>
@@ -248,16 +252,16 @@ round-robin</td>
</tbody>
</table>
<ol class="arabic simple" start="7">
-<li>Optionally, if “Primary/backup” is selected for “Multi Site Origin Algorithm”, a new parameter \u201crank\u201d should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of “2” precedes OS with the rank of “5”. For any OS, if rank value is not defined in its profile, its rank value will default to \u201c1\u201d.</li>
+<li>Optionally, there are two configuration options that can set the order of the origins used if “Primary/backup” is selected for “Multi Site Origin Algorithm”. By creating location-based cachegroups and assigning the origin servers accordingly and defining these cachegroups as parents for specific mids, location-based primary/secondary selection can be made. If primary/secondary selection should be the same for all mids, then a new parameter \u201crank\u201d should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of “2” precedes OS with the rank of “5”. For any OS, if rank value is not defined in its profile, its rank value will default to \u201c1\u201d. In the event that both location based cachegroups are used alongside rank, sorting will be by cachegroup first and rank second. In this way it is possible to have specific bac
kup servers for use at specific locations.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/mso-rank.png"><img alt="../../_images/mso-rank.png" class="align-center" src="../../_images/mso-rank.png" /></a>
+<a class="reference internal image-reference" href="../../_images/mso-rank.png"><img alt="../../_images/mso-rank.png" class="align-center" src="../../_images/mso-rank.png" style="width: 585.0px; height: 105.6px;" /></a>
<ol class="arabic simple" start="8">
<li>Assign the parent.config location parameter to the MID profile:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png"><img alt="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" class="align-center" src="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" /></a>
+<a class="reference internal image-reference" href="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png"><img alt="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" class="align-center" src="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" style="width: 658.0px; height: 601.0px;" /></a>
<ol class="arabic" start="9">
<li><p class="first">Configure the mid hdr_rewrite on the delivery service, example:</p>
-<div class="highlight-python"><div class="highlight"><pre>cond %{REMAP_PSEUDO_HOOK} __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_response_codes "400,404,412" __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_response_codes "502,503" __RETURN__ set-config proxy.config.http.connect_attempts_timeout 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries_dead_server 1 __RETURN__ set-config proxy.config.http.transaction_active_timeout_in 5 [L] __RETURN__
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cond</span> <span class="o">%</span><span class="p">{</span><span class="n">REMAP_PSEUDO_HOOK</span><span class="p">}</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_enabled</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_enabled</span> <sp
an class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_response_codes</span> <span class="s2">"400,404,412"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_response_codes</span> <span class="s2">"502,503"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span
> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_timeout</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries_dead_server</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set<
/span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">transaction_active_timeout_in</span> <span class="mi">5</span> <span class="p">[</span><span class="n">L</span><span class="p">]</span> <span class="n">__RETURN__</span>
</pre></div>
</div>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/quick_howto/regionalgeo.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/quick_howto/regionalgeo.html b/docs/1.7.0/admin/quick_howto/regionalgeo.html
index 97f9b0d..f753af0 100644
--- a/docs/1.7.0/admin/quick_howto/regionalgeo.html
+++ b/docs/1.7.0/admin/quick_howto/regionalgeo.html
@@ -196,24 +196,24 @@
<li>Prepare RGB configuration file</li>
</ol>
<p>RGB uses a configuration file in JSON format to define regional geo-blocking rules for delivery services. The file needs to be put on an HTTP server accessible to Traffic Router. An example of the JSON is as follows:</p>
-<div class="highlight-python"><div class="highlight"><pre>{
-"deliveryServices":
- [
- {
- "deliveryServiceId": "hls-live",
- "urlRegex": ".*live4\\.m3u8",
- "geoLocation": {"includePostalCode":["N0H", "L9V", "L9W"]},
- "redirectUrl": "http://third-party.com/blacked_out.html"
- },
- {
- "deliveryServiceId": "hls-live",
- "urlRegex": ".*live5\\.m3u8",
- "ipWhiteList": [185.68.71.9/22","142.232.0.79/24"],
- "geoLocation": {"excludePostalCode":["N0H", "L9V"]},
- "redirectUrl": "/live5_low_bitrate.m3u8"
- }
- ]
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+<span class="s2">"deliveryServices"</span><span class="p">:</span>
+ <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="s2">"hls-live"</span><span class="p">,</span>
+ <span class="s2">"urlRegex"</span><span class="p">:</span> <span class="s2">".*live4</span><span class="se">\\</span><span class="s2">.m3u8"</span><span class="p">,</span>
+ <span class="s2">"geoLocation"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"includePostalCode"</span><span class="p">:[</span><span class="s2">"N0H"</span><span class="p">,</span> <span class="s2">"L9V"</span><span class="p">,</span> <span class="s2">"L9W"</span><span class="p">]},</span>
+ <span class="s2">"redirectUrl"</span><span class="p">:</span> <span class="s2">"http://third-party.com/blacked_out.html"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="s2">"hls-live"</span><span class="p">,</span>
+ <span class="s2">"urlRegex"</span><span class="p">:</span> <span class="s2">".*live5</span><span class="se">\\</span><span class="s2">.m3u8"</span><span class="p">,</span>
+ <span class="s2">"ipWhiteList"</span><span class="p">:</span> <span class="p">[</span><span class="mf">185.68</span><span class="o">.</span><span class="mf">71.9</span><span class="o">/</span><span class="mi">22</span><span class="s2">","</span><span class="mf">142.232</span><span class="o">.</span><span class="mf">0.79</span><span class="o">/</span><span class="mi">24</span><span class="s2">"],</span>
+ <span class="s2">"geoLocation"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"excludePostalCode"</span><span class="p">:[</span><span class="s2">"N0H"</span><span class="p">,</span> <span class="s2">"L9V"</span><span class="p">]},</span>
+ <span class="s2">"redirectUrl"</span><span class="p">:</span> <span class="s2">"/live5_low_bitrate.m3u8"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
<ul class="simple">
@@ -231,23 +231,23 @@
<li>“regional_geoblocking.polling.url”: the HTTP URL of RGB configuration file. Traffic Router will fetch the file from this URL.</li>
<li>“regional_geoblocking.polling.interval”: the interval that Traffic Router polls the RGB configuration file.</li>
</ul>
-<a class="reference internal image-reference" href="../../_images/regionalgeo01.png"><img alt="../../_images/regionalgeo01.png" class="align-center" src="../../_images/regionalgeo01.png" /></a>
+<a class="reference internal image-reference" href="../../_images/regionalgeo01.png"><img alt="../../_images/regionalgeo01.png" class="align-center" src="../../_images/regionalgeo01.png" style="width: 1234.0px; height: 430.0px;" /></a>
<ol class="arabic simple" start="3">
<li>Enable RGB for a delivery service</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/regionalgeo02.png"><img alt="../../_images/regionalgeo02.png" class="align-center" src="../../_images/regionalgeo02.png" /></a>
+<a class="reference internal image-reference" href="../../_images/regionalgeo02.png"><img alt="../../_images/regionalgeo02.png" class="align-center" src="../../_images/regionalgeo02.png" style="width: 1046.0px; height: 1054.0px;" /></a>
<ol class="arabic simple" start="4">
<li>Make configuration effective</li>
</ol>
<p>Go to Tools->Snapshot CRConfig, perform \u201cDiff CRConfig\u201d and click “Write CRConfig”.</p>
-<a class="reference internal image-reference" href="../../_images/regionalgeo03.png"><img alt="../../_images/regionalgeo03.png" class="align-center" src="../../_images/regionalgeo03.png" /></a>
+<a class="reference internal image-reference" href="../../_images/regionalgeo03.png"><img alt="../../_images/regionalgeo03.png" class="align-center" src="../../_images/regionalgeo03.png" style="width: 464.8px; height: 128.8px;" /></a>
<ol class="arabic simple" start="5">
<li>Traffic Router access log with RGB</li>
</ol>
<p>RGB extends the field of “rtype” and adds a new field “rgb” in Traffic Router access.log to help to monitor the working of this feature.</p>
<p>For “rtype”, RGALT indicates that a request is redirected to an alternate URL by RGB; RGDENY indicates that a request is denied by RGB because there is no matching rule in JSON for this request.</p>
<p>For “rgb”, when RGB is enabled, it will be non-empty with following format:</p>
-<div class="highlight-python"><div class="highlight"><pre>{FSA}:{allowed/disallowed}:{include/exclude postal}:{fallback config/current config}:{allowed by whitelist/otherwise}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span><span class="n">FSA</span><span class="p">}:{</span><span class="n">allowed</span><span class="o">/</span><span class="n">disallowed</span><span class="p">}:{</span><span class="n">include</span><span class="o">/</span><span class="n">exclude</span> <span class="n">postal</span><span class="p">}:{</span><span class="n">fallback</span> <span class="n">config</span><span class="o">/</span><span class="n">current</span> <span class="n">config</span><span class="p">}:{</span><span class="n">allowed</span> <span class="n">by</span> <span class="n">whitelist</span><span class="o">/</span><span class="n">otherwise</span><span class="p">}</span>
</pre></div>
</div>
<ul class="simple">
@@ -258,11 +258,11 @@
<li>{allowed by whitelist/otherwise}: If a request is allowed by whitelist, this flag is set to 1; for all other cases, it is 0.</li>
</ul>
<p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>1446442214.685 qtype=HTTP chi=129.100.254.79 url="http://ccr.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="-" rdtl=- rerr="-" rgb="N6G:1:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/live5.m3u8 rh="-"
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1446442214.685</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">129.100</span><span class="o">.</span><span class="mf">254.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live5.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span
class="o">=</span><span class="s2">"N6G:1:X:0:0"</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">live5</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
-1446442219.181 qtype=HTTP chi=184.68.71.9 url="http://ccr.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGALT rloc="-" rdtl=- rerr="-" rgb="-:0:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/low_bitrate.m3u8 rh="-"
+<span class="mf">1446442219.181</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">184.68</span><span class="o">.</span><span class="mf">71.9</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live5.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">RGALT</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"-:0:X:0:0"</span> <span cl
ass="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">low_bitrate</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
-1446445521.677 qtype=HTTP chi=24.114.29.79 url="http://ccr.geo2.cdn.com/live51.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGDENY rloc="-" rdtl=- rerr="-" rgb="L4S:0:-:0:0" pssc=520 ttms=3 rurl="-" rh="-"
+<span class="mf">1446445521.677</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">24.114</span><span class="o">.</span><span class="mf">29.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live51.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">RGDENY</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"L4S:0:-:0:0"</span> <sp
an class="n">pssc</span><span class="o">=</span><span class="mi">520</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
</pre></div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/quick_howto/steering.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/quick_howto/steering.html b/docs/1.7.0/admin/quick_howto/steering.html
index 839b30b..918c8a3 100644
--- a/docs/1.7.0/admin/quick_howto/steering.html
+++ b/docs/1.7.0/admin/quick_howto/steering.html
@@ -191,19 +191,19 @@
<ol class="arabic simple">
<li>Create two target delivery services in Traffic Ops. They must both be HTTP delivery services that are part of the same CDN.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering01.png"><img alt="../../_images/steering01.png" class="align-center" src="../../_images/steering01.png" /></a>
+<a class="reference internal image-reference" href="../../_images/steering01.png"><img alt="../../_images/steering01.png" class="align-center" src="../../_images/steering01.png" style="width: 1172.0px; height: 232.0px;" /></a>
<ol class="arabic simple" start="2">
<li>Create a delivery service with type STEERING in Traffic Ops.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering02.png"><img alt="../../_images/steering02.png" class="align-center" src="../../_images/steering02.png" /></a>
+<a class="reference internal image-reference" href="../../_images/steering02.png"><img alt="../../_images/steering02.png" class="align-center" src="../../_images/steering02.png" style="width: 811.0px; height: 617.0px;" /></a>
<ol class="arabic simple" start="3">
<li>Click the ‘Manage Steering Assignments’ button on the delivery service screen to assign targets.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering03.png"><img alt="../../_images/steering03.png" class="align-center" src="../../_images/steering03.png" /></a>
+<a class="reference internal image-reference" href="../../_images/steering03.png"><img alt="../../_images/steering03.png" class="align-center" src="../../_images/steering03.png" style="width: 757.0px; height: 598.0px;" /></a>
<ol class="arabic simple" start="4">
<li>Create a user with the role of Steering.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering04.png"><img alt="../../_images/steering04.png" class="align-center" src="../../_images/steering04.png" /></a>
+<a class="reference internal image-reference" href="../../_images/steering04.png"><img alt="../../_images/steering04.png" class="align-center" src="../../_images/steering04.png" style="width: 650.0px; height: 487.0px;" /></a>
<ol class="arabic" start="5">
<li><p class="first">As the steering user, assign weights to target delivery services. This will require logging in to Traffic Ops first via <code class="docutils literal"><span class="pre">http://to.kabletown.net/api/1.2/user/login</span></code> and storing the mojolicious cookie.</p>
<blockquote>
@@ -212,15 +212,15 @@
</div></blockquote>
</li>
</ol>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"targets"</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">"targets"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"weight"</span><span class="p">:</span> <span class="s">"1000"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-1"</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"1000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"weight"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-2"</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-2"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -234,21 +234,21 @@
</div></blockquote>
</li>
</ol>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"filters"</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">"filters"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">gototarget1</span><span class="se">\\</span><span class="s">..*"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-1"</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">gototarget1</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s">"targets"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"targets"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"weight"</span><span class="p">:</span> <span class="s">"1000"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-1"</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"1000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"weight"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-2"</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-2"</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/1.7.0/admin/traffic_monitor.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/traffic_monitor.html b/docs/1.7.0/admin/traffic_monitor.html
index b5ba3d8..75e7310 100644
--- a/docs/1.7.0/admin/traffic_monitor.html
+++ b/docs/1.7.0/admin/traffic_monitor.html
@@ -107,7 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Monitor Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
@@ -210,7 +210,7 @@
<li><p class="first">Take the config from Traffic Ops - run : <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">/opt/traffic_monitor/bin/traffic_monitor_config.pl</span></code></p>
<blockquote>
<div><p>Sample output:</p>
-<div class="highlight-python"><div class="highlight"><pre>traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt
+<div class="highlight-default"><div class="highlight"><pre><span></span>traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt
DEBUG: traffic_ops selected: https://traffic-ops.cdn.kabletown.net
DEBUG: traffic_ops login: admin:kl0tevax
DEBUG: Config write mode: prompt
@@ -293,13 +293,13 @@ traffic_mon #
</div></blockquote>
</li>
<li><p class="first">Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code></p>
-<div class="highlight-python"><div class="highlight"><pre>Using CATALINA_BASE: /opt/tomcat
-Using CATALINA_HOME: /opt/tomcat
-Using CATALINA_TMPDIR: /opt/tomcat/temp
-Using JRE_HOME: /usr
-Using CLASSPATH:/opt/tomcat/bin/bootstrap.jar
-Using CATALINA_PID:/var/run/tomcat/tomcat.pid
-Starting tomcat [ OK ]
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Using</span> <span class="n">CATALINA_BASE</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span>
+<span class="n">Using</span> <span class="n">CATALINA_HOME</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span>
+<span class="n">Using</span> <span class="n">CATALINA_TMPDIR</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="n">temp</span>
+<span class="n">Using</span> <span class="n">JRE_HOME</span><span class="p">:</span> <span class="o">/</span><span class="n">usr</span>
+<span class="n">Using</span> <span class="n">CLASSPATH</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">bootstrap</span><span class="o">.</span><span class="n">jar</span>
+<span class="n">Using</span> <span class="n">CATALINA_PID</span><span class="p">:</span><span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="n">tomcat</span><span class="o">.</span><span class="n">pid</span>
+<span class="n">Starting</span> <span class="n">tomcat</span> <span class="p">[</span> <span class="n">OK</span> <span class="p">]</span>
</pre></div>
</div>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/traffic_ops_config.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/traffic_ops_config.html b/docs/1.7.0/admin/traffic_ops_config.html
index 06ce343..da47adf 100644
--- a/docs/1.7.0/admin/traffic_ops_config.html
+++ b/docs/1.7.0/admin/traffic_ops_config.html
@@ -103,7 +103,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Configuring Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
@@ -315,7 +315,7 @@ The Traffic Monitor IP addresses have to be included in this, if they are using
</tr>
<tr class="row-even"><td>purge_allow_ip</td>
<td>ip_allow.config</td>
-<td>The IP address range that is allowed to execute the PURGE method on the caches (not related to <a class="reference internal" href="traffic_ops_using.html#rl-purge"><em>Invalidate Content</em></a>)</td>
+<td>The IP address range that is allowed to execute the PURGE method on the caches (not related to <a class="reference internal" href="traffic_ops_using.html#rl-purge"><span class="std std-ref">Invalidate Content</span></a>)</td>
</tr>
<tr class="row-odd"><td>health.threshold.loadavg</td>
<td>rascal.properties</td>
@@ -377,7 +377,7 @@ Value is left blank.</td>
</div>
<div class="section" id="configuring-content-purge">
<h2>Configuring Content Purge<a class="headerlink" href="#configuring-content-purge" title="Permalink to this headline">�</a></h2>
-<p>Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html">Regex Revalidate Plugin</a> to purge content from the system. We don’t actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it’s config file, and will pick up changes to it without a <cite>traffic_line -x</cite> signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the low
er tiers with the content that should be purged from the higher tiers without hitting the origin. This is why the ort script (see <a class="reference internal" href="traffic_server.html#reference-traffic-ops-ort"><em>Configuring Traffic Server</em></a>) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the <cite>regex_revalidate.config</cite> file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the <cite>regex_revalidate.config</cite> file.</p>
+<p>Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html">Regex Revalidate Plugin</a> to purge content from the system. We don’t actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it’s config file, and will pick up changes to it without a <cite>traffic_line -x</cite> signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the low
er tiers with the content that should be purged from the higher tiers without hitting the origin. This is why the ort script (see <a class="reference internal" href="traffic_server.html#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a>) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the <cite>regex_revalidate.config</cite> file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the <cite>regex_revalidate.config</cite> file.</p>
<p>Content Purge is controlled by the following parameters in the profile of the cache:</p>
<table border="1" class="docutils">
<colgroup>
@@ -424,13 +424,13 @@ For example: –config regex_revalidate.config</td>
<li>Start the kickstart installation.</li>
</ol>
<p>Create a ks.src file in the root of the selection location. See the example below:</p>
-<div class="highlight-python"><div class="highlight"><pre>mkdir newdir
-cd newdir/
-cp -r ../centos65/* .
-vim ks.src
-vim isolinux/isolinux.cfg
-cd vim osversions.cfg
-vim osversions.cfg
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">newdir</span>
+<span class="n">cd</span> <span class="n">newdir</span><span class="o">/</span>
+<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="o">../</span><span class="n">centos65</span><span class="o">/*</span> <span class="o">.</span>
+<span class="n">vim</span> <span class="n">ks</span><span class="o">.</span><span class="n">src</span>
+<span class="n">vim</span> <span class="n">isolinux</span><span class="o">/</span><span class="n">isolinux</span><span class="o">.</span><span class="n">cfg</span>
+<span class="n">cd</span> <span class="n">vim</span> <span class="n">osversions</span><span class="o">.</span><span class="n">cfg</span>
+<span class="n">vim</span> <span class="n">osversions</span><span class="o">.</span><span class="n">cfg</span>
</pre></div>
</div>
<p>This is a standard kickstart formatted file that the generate ISO process uses to create the kickstart (ks.cfg) file for the install. The generate ISO process uses the ks.src, overwriting any information set in the Generate ISO tab in Traffic Ops, creating ks.cfg.</p>
[09/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/cache_stats.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/cache_stats.html b/docs/latest/development/traffic_ops_api/v12/cache_stats.html
index 0a555a1..8803956 100644
--- a/docs/latest/development/traffic_ops_api/v12/cache_stats.html
+++ b/docs/latest/development/traffic_ops_api/v12/cache_stats.html
@@ -304,49 +304,49 @@
</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">"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>
+<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">"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">29</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"bandwidth"</span><span class="p">,</span>
- <span class="s">"tags"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"cdn"</span><span class="p">:</span> <span class="s">"over-the-top"</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">29</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bandwidth"</span><span class="p">,</span>
+ <span class="s2">"tags"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"over-the-top"</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-10T22:40:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-10T22:40:00Z"</span><span class="p">,</span>
<span class="mi">229340299720</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-10T22:41:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-10T22:41:00Z"</span><span class="p">,</span>
<span class="mf">224309221713.334</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-10T22:42:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-10T22:42:00Z"</span><span class="p">,</span>
<span class="mf">229551834168.334</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-10T22:43:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-10T22:43:00Z"</span><span class="p">,</span>
<span class="mf">225179658876.667</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-10T22:44:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-10T22:44:00Z"</span><span class="p">,</span>
<span class="mi">230443968275</span>
<span class="p">]</span>
<span class="p">]</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">970410.295</span><span class="p">,</span>
- <span class="s">"count"</span><span class="p">:</span> <span class="mi">1376041798</span><span class="p">,</span>
- <span class="s">"fifthPercentile"</span><span class="p">:</span> <span class="mf">202.03</span><span class="p">,</span>
- <span class="s">"max"</span><span class="p">:</span> <span class="mf">3875441.02</span><span class="p">,</span>
- <span class="s">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">2957940.93</span><span class="p">,</span>
- <span class="s">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">2366728.63</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">970410.295</span><span class="p">,</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1376041798</span><span class="p">,</span>
+ <span class="s2">"fifthPercentile"</span><span class="p">:</span> <span class="mf">202.03</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">3875441.02</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">2957940.93</span><span class="p">,</span>
+ <span class="s2">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">2366728.63</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/cachegroup.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/cachegroup.html b/docs/latest/development/traffic_ops_api/v12/cachegroup.html
index 53c4c40..26802f7 100644
--- a/docs/latest/development/traffic_ops_api/v12/cachegroup.html
+++ b/docs/latest/development/traffic_ops_api/v12/cachegroup.html
@@ -190,16 +190,16 @@
<span id="to-api-v12-cachegroup"></span><h1>Cache Group<a class="headerlink" href="#cache-group" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-cachegroups">
<span id="to-api-v12-cachegroups-route"></span><h2>/api/1.2/cachegroups<a class="headerlink" href="#api-1-2-cachegroups" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cachegroups.json</strong></p>
+<p><strong>GET /api/1.1/cachegroups</strong></p>
<blockquote>
<div><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="23%" />
-<col width="8%" />
-<col width="70%" />
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -208,70 +208,86 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>Longitude for the Cache Group</td>
+<td>Local unique identifier for the Cache Group</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
-<td>Identifier that refers to the ‘id’ field of different Cache Group entry.</td>
+<td>The Time / Date this entry was last updated</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
<td>string</td>
-<td>The Time / Date this entry was last updated</td>
+<td>Latitude for the Cache Group</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
<td>string</td>
-<td>The type name of Cache Group entry</td>
+<td>Longitude for the Cache Group</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The name of the Cache Group entry</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
<td>string</td>
-<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+<td>Parent cachegroup ID.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td>
<td>string</td>
-<td>Latitude for the Cache Group</td>
+<td>Parent cachegroup name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
<td>string</td>
-<td>Local unique identifier for the Cache Group</td>
+<td>Secondary parent cachegroup ID.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>Abbreviation of the Cache Group Name</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</td>
+</tr>
</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">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:32:03"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dccmc"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago-1"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -281,10 +297,10 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cachegroups/trimmed.json</strong></p>
+<p><strong>GET /api/1.2/cachegroups/trimmed</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
-<p>Role(s) Required Required: None</p>
+<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -306,23 +322,116 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "name": "dc-chicago"
- },
- {
- "name": "dc-cmc"
- }
- ],
-}
+<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">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</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/cachegroup/:parameter_id/parameter.json</strong></p>
+<p><strong>GET /api/1.2/cachegroups/:id</strong></p>
+<blockquote>
+<div><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="30%" />
+<col width="7%" />
+<col width="63%" />
+</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>Local unique identifier for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
+<td>string</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
+<td>string</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
+<td>string</td>
+<td>Parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td>
+<td>string</td>
+<td>Parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</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">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</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/cachegroup/:parameter_id/parameter</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -375,16 +484,16 @@
</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">"cachegroups"</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="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -395,7 +504,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cachegroupparameters.json</strong></p>
+<p><strong>GET /api/1.2/cachegroupparameters</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -432,23 +541,23 @@
</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">"cachegroupParameters"</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="s2">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"380"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"380"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -459,7 +568,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cachegroups/:parameter_id/parameter/available.json</strong></p>
+<p><strong>GET /api/1.2/cachegroups/:parameter_id/parameter/available</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -508,15 +617,15 @@
</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">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -576,13 +685,13 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"cache_group_edge"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"cg_edge"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
- <span class="s">"parentCachegroup"</span><span class="p">:</span> <span class="s">"cache_group_mid"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"EDGE_LOC"</span>
+<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">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"cg_edge"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s2">"parentCachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_mid"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"EDGE_LOC"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -659,25 +768,25 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Cachegroup successfully created: cache_group_edge"</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">"Cachegroup successfully created: cache_group_edge"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">'longitude'</span> <span class="p">:</span> <span class="s">'45'</span><span class="p">,</span>
- <span class="s">'lastUpdated'</span> <span class="p">:</span> <span class="s">'2016-01-25 13:55:30'</span><span class="p">,</span>
- <span class="s">'shortName'</span> <span class="p">:</span> <span class="s">'cg_edge'</span><span class="p">,</span>
- <span class="s">'name'</span> <span class="p">:</span> <span class="s">'cache_group_edge'</span><span class="p">,</span>
- <span class="s">'parentCachegroup'</span> <span class="p">:</span> <span class="s">'cache_group_mid'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'latitude'</span> <span class="p">:</span> <span class="s">'12'</span><span class="p">,</span>
- <span class="s">'typeName'</span> <span class="p">:</span> <span class="s">'EDGE_LOC'</span><span class="p">,</span>
- <span class="s">'id'</span> <span class="p">:</span> <span class="s">'104'</span><span class="p">,</span>
- <span class="s">'parentCachegroupId'</span> <span class="p">:</span> <span class="s">'103'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'longitude'</span> <span class="p">:</span> <span class="s1">'45'</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s1">'shortName'</span> <span class="p">:</span> <span class="s1">'cg_edge'</span><span class="p">,</span>
+ <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_mid'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'latitude'</span> <span class="p">:</span> <span class="s1">'12'</span><span class="p">,</span>
+ <span class="s1">'typeName'</span> <span class="p">:</span> <span class="s1">'EDGE_LOC'</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'104'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroupId'</span> <span class="p">:</span> <span class="s1">'103'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -756,13 +865,13 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"cache_group_edge"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"cg_edge"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
- <span class="s">"parentCachegroup"</span><span class="p">:</span> <span class="s">"cache_group_mid"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"EDGE_LOC"</span>
+<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">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"cg_edge"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s2">"parentCachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_mid"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"EDGE_LOC"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -839,25 +948,25 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Cachegroup was updated: cache_group_edge"</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">"Cachegroup was updated: cache_group_edge"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">'longitude'</span> <span class="p">:</span> <span class="s">'45'</span><span class="p">,</span>
- <span class="s">'lastUpdated'</span> <span class="p">:</span> <span class="s">'2016-01-25 13:55:30'</span><span class="p">,</span>
- <span class="s">'shortName'</span> <span class="p">:</span> <span class="s">'cg_edge'</span><span class="p">,</span>
- <span class="s">'name'</span> <span class="p">:</span> <span class="s">'cache_group_edge'</span><span class="p">,</span>
- <span class="s">'parentCachegroup'</span> <span class="p">:</span> <span class="s">'cache_group_mid'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'latitude'</span> <span class="p">:</span> <span class="s">'12'</span><span class="p">,</span>
- <span class="s">'typeName'</span> <span class="p">:</span> <span class="s">'EDGE_LOC'</span><span class="p">,</span>
- <span class="s">'id'</span> <span class="p">:</span> <span class="s">'104'</span><span class="p">,</span>
- <span class="s">'parentCachegroupId'</span> <span class="p">:</span> <span class="s">'103'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'longitude'</span> <span class="p">:</span> <span class="s1">'45'</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s1">'shortName'</span> <span class="p">:</span> <span class="s1">'cg_edge'</span><span class="p">,</span>
+ <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_mid'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'latitude'</span> <span class="p">:</span> <span class="s1">'12'</span><span class="p">,</span>
+ <span class="s1">'typeName'</span> <span class="p">:</span> <span class="s1">'EDGE_LOC'</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'104'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroupId'</span> <span class="p">:</span> <span class="s1">'103'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -920,11 +1029,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Cachegroup was deleted: cache_group_edge"</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">"Cachegroup was deleted: cache_group_edge"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1020,18 +1129,18 @@
</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">"cachegroupName"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"action"</span><span class="p">:</span> <span class="s">"queue"</span><span class="p">,</span>
- <span class="s">"serverNames"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"atsec-chi-01"</span><span class="p">,</span>
- <span class="s">"atsec-chi-02"</span><span class="p">,</span>
- <span class="s">"atsec-chi-03"</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="s2">"cachegroupName"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"queue"</span><span class="p">,</span>
+ <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-01"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-02"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-03"</span><span class="p">,</span>
<span class="p">],</span>
- <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"93"</span><span class="p">,</span>
- <span class="s">"cdn"</span><span class="p">:</span> <span class="s">"cdn_number_1"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"93"</span><span class="p">,</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1086,8 +1195,8 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1136,20 +1245,20 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": {
- "id": 3,
- "serverNames": [ "atlanta-edge-01", "atlanta-edge-07" ],
- "deliveryServices": [ 234, 235 ]
- }
- "alerts":
- [
- {
- "level": "success",
- "text": "Delivery services successfully assigned to all the servers of cache group 3."
- }
- ],
-}
+<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">"id"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"atlanta-edge-01"</span><span class="p">,</span> <span class="s2">"atlanta-edge-07"</span> <span class="p">],</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</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">"Delivery services successfully assigned to all the servers of cache group 3."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
[39/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/deliveryservice.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/deliveryservice.html b/docs/1.7.0/development/traffic_ops_api/v11/deliveryservice.html
index e5c86cd..7049ed7 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/deliveryservice.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/deliveryservice.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-ds"></span><h1>Delivery Service<a class="headerlink" href="#delivery-service" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-deliveryservices">
<span id="to-api-v11-ds-route"></span><h2>/api/1.1/deliveryservices<a class="headerlink" href="#api-1-1-deliveryservices" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/deliveryservices.json</strong></p>
+<p><strong>GET /api/1.1/deliveryservices</strong></p>
<blockquote>
<div><p>Retrieves all delivery services. See also <a class="reference external" href="http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
@@ -198,82 +198,76 @@
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="10%" />
-<col width="3%" />
-<col width="50%" />
-<col width="38%" />
+<col width="15%" />
+<col width="5%" />
+<col width="80%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
-<th class="head"> </th>
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
-<td>string</td>
-<td>Unique string that describes this deliveryservice.</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">active</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
<td>bool</td>
<td>true if active, false if inactive.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
<td>string</td>
<td>Cache URL rule to apply to this delivery service.</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
-<td>string</td>
-<td><ul class="first last simple">
-<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
-<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
-<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
-</ul>
-</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
-<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
<td>string</td>
<td>The path portion of the URL to check this deliveryservice for health.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS bypass response.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
<td>string</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
<td>string</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
@@ -283,125 +277,139 @@ globalMaxMbps traffic on this deliveryservice.</td>
<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
routing to the content by Traffic Router.</p>
</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
<td>string</td>
<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
-<td> </td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">headerRewrite</span></code></td>
-<td>string</td>
-<td>The EDGE header rewrite actions to perform.</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
<td>string</td>
<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The deliveryservice id (database row number).</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
<td>string</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
<td>bool</td>
<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
<td>Description field 2.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
<td>string</td>
<td>Description field 2.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
<td>array</td>
<td>Array of matchList hashes.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
<td>string</td>
<td>The set Number of the matchList.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
<td>string</td>
<td>The regexp for the matchList.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
<td>string</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
-<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
<td>string</td>
<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
<td>string</td>
<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
-<td>string</td>
-<td>The MID header rewrite actions to perform.</td>
-<td> </td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
-<td>string</td>
-<td> </td>
-<td>Is the Multi Site Origin feature enabled for this delivery service. See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
<td>The origin server base URL (FQDN when used in this instance, includes the
protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
<td>string</td>
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
-<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
<td>string</td>
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
<td>string</td>
<td><ul class="first last simple">
<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
@@ -409,109 +417,142 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<li>2: drop query string at edge, and do not use it in the cache-key.</li>
</ul>
</td>
-<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
<td>string</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
<td>string</td>
<td>Additional raw remap line text.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
<td>bool</td>
<td><ul class="first last simple">
<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
<li>true: token based auth is enabled for this deliveryservice.</li>
</ul>
</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
<td>string</td>
-<td><p class="first">How to treat range requests:</p>
-<ul class="last simple">
-<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
-<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
-<li>2 Use the cache_range_requests plugin.</li>
-</ul>
-</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
-<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
<td>string</td>
-<td>Entry points into the CDN for this deliveryservice.</td>
<td> </td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
- },
- { .. },
- { .. }
- ],
-}
+<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">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="o">..</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.1/deliveryservices/:id.json</strong></p>
+<p><strong>GET /api/1.1/deliveryservices/:id</strong></p>
<blockquote>
<div><p>Retrieves a specific delivery service. See also <a class="reference external" href="http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
@@ -530,58 +571,65 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
-<td>string</td>
-<td>Unique string that describes this deliveryservice.</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">active</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
<td>bool</td>
<td>true if active, false if inactive.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
<td>string</td>
<td>Cache URL rule to apply to this delivery service.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
-<td>string</td>
-<td><ul class="first last simple">
-<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
-<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
-<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
-</ul>
-</td>
-</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
<td>string</td>
<td>The path portion of the URL to check this deliveryservice for health.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS bypass response.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
<td>string</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
<td>string</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
@@ -592,21 +640,25 @@ globalMaxMbps traffic on this deliveryservice.</td>
routing to the content by Traffic Router.</p>
</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
<td>string</td>
<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">headerRewrite</span></code></td>
-<td>string</td>
-<td>The EDGE header rewrite actions to perform.</td>
-</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
<td>string</td>
<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
@@ -620,43 +672,59 @@ globalMaxMbps traffic on this deliveryservice.</td>
<td>string</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
<td>bool</td>
<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
<td>Description field 2.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
<td>string</td>
<td>Description field 2.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
<td>array</td>
<td>Array of matchList hashes.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
<td>string</td>
<td>The set Number of the matchList.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
<td>string</td>
<td>The regexp for the matchList.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
<td>string</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
<td>string</td>
<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
@@ -665,23 +733,44 @@ available).</td>
<td>string</td>
<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
-<td>string</td>
-<td>The MID header rewrite actions to perform.</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
<td>The origin server base URL (FQDN when used in this instance, includes the
protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
<td>string</td>
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
<td>string</td>
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
<td>string</td>
<td><ul class="first last simple">
@@ -691,10 +780,24 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</ul>
</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
<td>string</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
<td>string</td>
<td>Additional raw remap line text.</td>
@@ -707,75 +810,101 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</ul>
</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
<td>string</td>
-<td><p class="first">How to treat range requests:</p>
-<ul class="last simple">
-<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
-<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
-<li>2 Use the cache_range_requests plugin.</li>
-</ul>
-</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
<td>string</td>
-<td>Entry points in to the CDN for this deliveryservice.</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
</tr>
</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">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"protocol"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"ccrDnsTtl"</span><span class="p">:</span> <span class="s">"3600"</span><span class="p">,</span>
- <span class="s">"checkPath"</span><span class="p">:</span> <span class="s">"/crossdomain.xml"</span><span class="p">,</span>
- <span class="s">"dnsBypassIp"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"dnsBypassIp6"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"dnsBypassTtl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"dscp"</span><span class="p">:</span> <span class="s">"40"</span><span class="p">,</span>
- <span class="s">"geoLimit"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"globalMaxMbps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"globalMaxTps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"headerRewrite"</span><span class="p">:</span> <span class="s">"add-header X-Powered-By: KABLETOWN [L]"</span><span class="p">,</span>
- <span class="s">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="s">"add-header X-Powered-By: KABLETOWN [L]"</span><span class="p">,</span>
- <span class="s">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"httpBypassFqdn"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"rangeRequestHandling"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"12"</span><span class="p">,</span>
- <span class="s">"infoUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"longDesc"</span><span class="p">:</span> <span class="s">"long_desc"</span><span class="p">,</span>
- <span class="s">"longDesc1"</span><span class="p">:</span> <span class="s">"long_desc_1"</span><span class="p">,</span>
- <span class="s">"longDesc2"</span><span class="p">:</span> <span class="s">"long_desc_2"</span><span class="p">,</span>
- <span class="s">"matchList"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HOST_REGEXP"</span><span class="p">,</span>
- <span class="s">"setNumber"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">.images</span><span class="se">\\</span><span class="s">..*"</span>
- <span class="p">}</span>
- <span class="p">],</span>
- <span class="s">"maxDnsAnswers"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"missLat"</span><span class="p">:</span> <span class="s">"41.881944"</span><span class="p">,</span>
- <span class="s">"missLong"</span><span class="p">:</span> <span class="s">"-87.627778"</span><span class="p">,</span>
- <span class="s">"orgServerFqdn"</span><span class="p">:</span> <span class="s">"http://cdl.origin.kabletown.net"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for cdn2.comcast.net"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"EDGE_CDN2"</span><span class="p">,</span>
- <span class="s">"qstringIgnore"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"signed"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HTTP"</span><span class="p">,</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"cdl-c2"</span><span class="p">,</span>
- <span class="s">"exampleURLs"</span><span class="p">:</span> <span class="p">[]</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -832,15 +961,15 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</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">"failover"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
- <span class="s">"destination"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"enabled"</span><span class="p">:</span> <span class="n">false</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">"failover"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
+ <span class="s2">"destination"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">},</span>
- <span class="s">"enabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -896,20 +1025,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -982,12 +1111,12 @@ delivery service that is down for maintenance.</td>
</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1063,14 +1192,14 @@ client to the overflow CDN.</td>
</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1225,22 +1354,22 @@ client to the overflow CDN.</td>
</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">"stats"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"count"</span><span class="p">:</span> <span class="mi">988</span><span class="p">,</span>
- <span class="s">"98thPercentile"</span><span class="p">:</span> <span class="mf">16589105.55958</span><span class="p">,</span>
- <span class="s">"min"</span><span class="p">:</span> <span class="mf">3185442.975</span><span class="p">,</span>
- <span class="s">"max"</span><span class="p">:</span> <span class="mf">17124754.257</span><span class="p">,</span>
- <span class="s">"5thPercentile"</span><span class="p">:</span> <span class="mf">3901253.95445</span><span class="p">,</span>
- <span class="s">"95thPercentile"</span><span class="p">:</span> <span class="mf">16013210.034</span><span class="p">,</span>
- <span class="s">"median"</span><span class="p">:</span> <span class="mf">8816895.576</span><span class="p">,</span>
- <span class="s">"mean"</span><span class="p">:</span> <span class="mf">8995846.31741194</span><span class="p">,</span>
- <span class="s">"stddev"</span><span class="p">:</span> <span class="mf">3941169.83683573</span><span class="p">,</span>
- <span class="s">"sum"</span><span class="p">:</span> <span class="mf">333296106.060112</span>
+ <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">988</span><span class="p">,</span>
+ <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">16589105.55958</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mf">3185442.975</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">17124754.257</span><span class="p">,</span>
+ <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">3901253.95445</span><span class="p">,</span>
+ <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">16013210.034</span><span class="p">,</span>
+ <span class="s2">"median"</span><span class="p">:</span> <span class="mf">8816895.576</span><span class="p">,</span>
+ <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">8995846.31741194</span><span class="p">,</span>
+ <span class="s2">"stddev"</span><span class="p">:</span> <span class="mf">3941169.83683573</span><span class="p">,</span>
+ <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">333296106.060112</span>
<span class="p">},</span>
- <span class="s">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
<span class="mi">1414303200000</span><span class="p">,</span>
<span class="mf">12923518.466</span>
@@ -1250,7 +1379,7 @@ client to the overflow CDN.</td>
<span class="mf">12625139.65</span>
<span class="p">]</span>
<span class="p">],</span>
- <span class="s">"label"</span><span class="p">:</span> <span class="s">"MID Kbps"</span>
+ <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"MID Kbps"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1317,22 +1446,22 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
- <span class="s">"orderby"</span><span class="p">:</span> <span class="s">"deliveryservice"</span><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">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"orderby"</span><span class="p">:</span> <span class="s2">"deliveryservice"</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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:43"</span><span class="p">,</span>
- <span class="s">"server"</span><span class="p">:</span> <span class="s">"20"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:43"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"20"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:44"</span><span class="p">,</span>
- <span class="s">"server"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:44"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">},</span>
<span class="p">],</span>
- <span class="s">"limit"</span><span class="p">:</span> <span class="mi">2</span>
+ <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">2</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1444,20 +1573,20 @@ client to the overflow CDN.</td>
</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
<span class="p">},</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1567,20 +1696,20 @@ client to the overflow CDN.</td>
</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
<span class="p">},</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1654,8 +1783,8 @@ client to the overflow CDN.</td>
</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="s">"Successfully deleted ssl keys for <xml_id>"</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="s2">"Successfully deleted ssl keys for <xml_id>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1717,20 +1846,20 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"ds-01"</span><span class="p">,</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN Engineering"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
- <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"some_key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"some_csr"</span><span class="p">,</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"some_crt"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN Engineering"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p"
<TRUNCATED>
[16/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/traffic_ops_using.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_ops_using.html b/docs/latest/admin/traffic_ops_using.html
index 6cc010c..6c1a40e 100644
--- a/docs/latest/admin/traffic_ops_using.html
+++ b/docs/latest/admin/traffic_ops_using.html
@@ -104,7 +104,7 @@
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Using Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
@@ -208,16 +208,16 @@
<td>A real time view into the main performance indicators of the CDNs managed by Traffic Control.
This view is sourced directly by the Traffic Monitor data and is updated every 10 seconds.
This is the default screen of Traffic Ops.
-See <a class="reference internal" href="#rl-health-table"><em>The Health Table</em></a> for details.</td>
+See <a class="reference internal" href="#rl-health-table"><span class="std std-ref">The Health Table</span></a> for details.</td>
</tr>
<tr class="row-odd"><td>Graph View</td>
<td>A real graphical time view into the main performance indicators of the CDNs managed by Traffic Control.
This view is sourced by the Traffic Monitor data and is updated every 10 seconds.
On loading, this screen will show a history of 24 hours of data from Traffic Stats
-See <a class="reference internal" href="#rl-health-graph"><em>Graph View</em></a> for details.</td>
+See <a class="reference internal" href="#rl-health-graph"><span class="std std-ref">Graph View</span></a> for details.</td>
</tr>
<tr class="row-even"><td>Server Checks</td>
-<td>A table showing the results of the periodic check extension scripts that are run. See <a class="reference internal" href="#rl-server-checks"><em>Server Checks</em></a></td>
+<td>A table showing the results of the periodic check extension scripts that are run. See <a class="reference internal" href="#rl-server-checks"><span class="std std-ref">Server Checks</span></a></td>
</tr>
<tr class="row-odd"><td>Daily Summary</td>
<td>A graph displaying the daily peaks of bandwidth, overall bytes served per day, and overall bytes served since initial installation
@@ -259,7 +259,7 @@ per CDN.</td>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Upload Server CSV</td>
-<td>Bulk add of servers from a csv file. See <a class="reference internal" href="#rl-bulkserver"><em>Bulk Upload Server</em></a></td>
+<td>Bulk add of servers from a csv file. See <a class="reference internal" href="#rl-bulkserver"><span class="std std-ref">Bulk Upload Server</span></a></td>
</tr>
</tbody>
</table>
@@ -278,7 +278,7 @@ per CDN.</td>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Global Profile</td>
-<td>The table of global parameters. See <a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><em>Profile Parameters</em></a>. This is where you Create/Read/Update/Delete parameters in the Global profile</td>
+<td>The table of global parameters. See <a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><span class="std std-ref">Profile Parameters</span></a>. This is where you Create/Read/Update/Delete parameters in the Global profile</td>
</tr>
<tr class="row-odd"><td>All Cache Groups</td>
<td>The table of all parameters <em>that are assgined to a cachegroup</em> - this may be slow to pull up, as there can be thousands of parameters.</td>
@@ -309,19 +309,19 @@ per CDN.</td>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Generate ISO</td>
-<td>Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See <a class="reference internal" href="#rl-generate-iso"><em>Generate ISO</em></a></td>
+<td>Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See <a class="reference internal" href="#rl-generate-iso"><span class="std std-ref">Generate ISO</span></a></td>
</tr>
<tr class="row-odd"><td>Queue Updates</td>
-<td>Send Updates to the caches. See <a class="reference internal" href="#rl-queue-updates"><em>Queue Updates and Snapshot CRConfig</em></a></td>
+<td>Send Updates to the caches. See <a class="reference internal" href="#rl-queue-updates"><span class="std std-ref">Queue Updates and Snapshot CRConfig</span></a></td>
</tr>
<tr class="row-even"><td>DB Dump</td>
<td>Backup the Database to a .sql file.</td>
</tr>
<tr class="row-odd"><td>Snapshot CRConfig</td>
-<td>Send updates to the Traffic Monitor / Traffic Router servers. See <a class="reference internal" href="#rl-queue-updates"><em>Queue Updates and Snapshot CRConfig</em></a></td>
+<td>Send updates to the Traffic Monitor / Traffic Router servers. See <a class="reference internal" href="#rl-queue-updates"><span class="std std-ref">Queue Updates and Snapshot CRConfig</span></a></td>
</tr>
<tr class="row-even"><td>Invalidate Content</td>
-<td>Invalidate or purge content from all caches in the CDN. See <a class="reference internal" href="#rl-purge"><em>Invalidate Content</em></a></td>
+<td>Invalidate or purge content from all caches in the CDN. See <a class="reference internal" href="#rl-purge"><span class="std std-ref">Invalidate Content</span></a></td>
</tr>
<tr class="row-odd"><td>Manage DNSSEC keys</td>
<td>Manage DNSSEC Keys for a chosen CDN.</td>
@@ -349,10 +349,10 @@ per CDN.</td>
<td>Create/Read/Update/Delete users</td>
</tr>
<tr class="row-even"><td>Profiles</td>
-<td>Create/Read/Update/Delete profiles. See <a class="reference internal" href="#rl-working-with-profiles"><em>Parameters and Profiles</em></a></td>
+<td>Create/Read/Update/Delete profiles. See <a class="reference internal" href="#rl-working-with-profiles"><span class="std std-ref">Parameters and Profiles</span></a></td>
</tr>
<tr class="row-odd"><td>Networks(ASNs)</td>
-<td>Create/Read/Update/Delete Autonomous System Numbers See <a class="reference internal" href="#rl-asn-czf"><em>The Coverage Zone File and ASN Table</em></a></td>
+<td>Create/Read/Update/Delete Autonomous System Numbers See <a class="reference internal" href="#rl-asn-czf"><span class="std std-ref">The Coverage Zone File and ASN Table</span></a></td>
</tr>
<tr class="row-even"><td>Hardware</td>
<td>Get detailed hardware information (note: this should be moved to a Traffic Ops Extension)</td>
@@ -554,7 +554,7 @@ must have an ssh key on the edge servers.</td>
<td>A unique string that identifies this delivery service.</td>
</tr>
<tr class="row-odd"><td>Content Routing Type</td>
-<td>The type of content routing this delivery service will use. See <a class="reference internal" href="#rl-ds-types"><em>Delivery Service Types</em></a>.</td>
+<td>The type of content routing this delivery service will use. See <a class="reference internal" href="#rl-ds-types"><span class="std std-ref">Delivery Service Types</span></a>.</td>
</tr>
<tr class="row-even"><td>Protocol</td>
<td><p class="first">The protocol to serve this delivery service to the clients with:</p>
@@ -569,7 +569,7 @@ must have an ssh key on the edge servers.</td>
<td>The DSCP value to mark IP packets to the client with.</td>
</tr>
<tr class="row-even"><td>Signed URLs</td>
-<td>Use Signed URLs? See <a class="reference internal" href="#rl-signed-urls"><em>Token Based Authentication</em></a>.</td>
+<td>Use Signed URLs? See <a class="reference internal" href="#rl-signed-urls"><span class="std std-ref">Token Based Authentication</span></a>.</td>
</tr>
<tr class="row-odd"><td>Query String Handling</td>
<td><p class="first">How to treat query strings:</p>
@@ -590,7 +590,7 @@ must have an ssh key on the edge servers.</td>
</td>
</tr>
<tr class="row-odd"><td>Geo Limit Redirect URL</td>
-<td>(for HTTP routed delivery services only) This is the URL Traffic Router will redirect to when Geo Limit Failure. See <em class="xref std std-ref">geolimit-failure-redirect-feature</em></td>
+<td>(for HTTP routed delivery services only) This is the URL Traffic Router will redirect to when Geo Limit Failure. See <span class="xref std std-ref">geolimit-failure-redirect-feature</span></td>
</tr>
<tr class="row-even"><td>Bypass FQDN</td>
<td>(for HTTP routed delivery services only) This is the FQDN Traffic Router will redirect to (with the same path) when the max Bps or Max Tps for this deliveryservice are exceeded.</td>
@@ -621,7 +621,7 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
<td>The Origin Server’s base URL. This includes the protocol (http or https). Example: <code class="docutils literal"><span class="pre">http://movies.origin.com</span></code></td>
</tr>
<tr class="row-odd"><td>Use Multi Site Origin Feature</td>
-<td>Enable the Multi Site Origin feature for this delivery service. See <a class="reference internal" href="#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+<td>Enable the Multi Site Origin feature for this delivery service. See <a class="reference internal" href="#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
<tr class="row-even"><td>Multi Site Origin Algorithm</td>
<td><ul class="first last simple">
@@ -633,7 +633,7 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
</td>
</tr>
<tr class="row-odd"><td>CCR profile</td>
-<td>The Traffic Router profile for this delivery service. See <a class="reference internal" href="#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a>.</td>
+<td>The Traffic Router profile for this delivery service. See <a class="reference internal" href="#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a>.</td>
</tr>
<tr class="row-even"><td>Maximum Bits per Second allowed globally</td>
<td>The maximum bits per second this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used
@@ -650,10 +650,10 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
<td>Default Longitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this long.</td>
</tr>
<tr class="row-even"><td>Edge Header Rewrite Rules</td>
-<td>Header Rewrite rules to apply for this delivery service at the EDGE tier. See <a class="reference internal" href="#rl-header-rewrite"><em>Header Rewrite Options and DSCP</em></a>. <a class="footnote-reference" href="#id6" id="id1">[1]</a></td>
+<td>Header Rewrite rules to apply for this delivery service at the EDGE tier. See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id6" id="id1">[1]</a></td>
</tr>
<tr class="row-odd"><td>Mid Header Rewrite Rules</td>
-<td>Header Rewrite rules to apply for this delivery service at the MID tier. See <a class="reference internal" href="#rl-header-rewrite"><em>Header Rewrite Options and DSCP</em></a>. <a class="footnote-reference" href="#id6" id="id2">[1]</a></td>
+<td>Header Rewrite rules to apply for this delivery service at the MID tier. See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id6" id="id2">[1]</a></td>
</tr>
<tr class="row-even"><td>Regex Remap Expression</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier. See <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html">ATS documentation on regex_remap</a>. <a class="footnote-reference" href="#id6" id="id3">[1]</a></td>
@@ -689,16 +689,16 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
<td>(Read Only) The last time this delivery service was updated.</td>
</tr>
<tr class="row-odd"><td>Number of edges assigned</td>
-<td>(Read Only - change by clicking the <strong>Server Assignments</strong> button at the bottom) The number of EDGE caches assigned to this delivery service. See <a class="reference internal" href="#rl-assign-edges"><em>Server Assignments</em></a>.</td>
+<td>(Read Only - change by clicking the <strong>Server Assignments</strong> button at the bottom) The number of EDGE caches assigned to this delivery service. See <a class="reference internal" href="#rl-assign-edges"><span class="std std-ref">Server Assignments</span></a>.</td>
</tr>
<tr class="row-even"><td>Number of static DNS entries</td>
-<td>(Read Only - change by clicking the <strong>Static DNS</strong> button at the bottom) The number of static DNS entries for this delivery service. See <a class="reference internal" href="#rl-static-dns"><em>Static DNS Entries</em></a>.</td>
+<td>(Read Only - change by clicking the <strong>Static DNS</strong> button at the bottom) The number of static DNS entries for this delivery service. See <a class="reference internal" href="#rl-static-dns"><span class="std std-ref">Static DNS Entries</span></a>.</td>
</tr>
<tr class="row-odd"><td>Example delivery URL</td>
<td>(Read Only) An example of how the delivery URL may start. This could be multiple rows if multiple HOST_REGEXP entries have been entered.</td>
</tr>
<tr class="row-even"><td>Regular expressions for this delivery service</td>
-<td>A subtable of the regular expressions to use when routing traffic for this delivery service. See <a class="reference internal" href="#rl-ds-regexp"><em>Delivery Service Regexp</em></a>.</td>
+<td>A subtable of the regular expressions to use when routing traffic for this delivery service. See <a class="reference internal" href="#rl-ds-regexp"><span class="std std-ref">Delivery Service Regexp</span></a>.</td>
</tr>
</tbody>
</table>
@@ -1070,7 +1070,7 @@ http.parent_proxy.connect_attempts_timeout</td>
</tr>
</tbody>
</table>
-<p>see <a class="reference internal" href="quick_howto/multi_site.html#rl-multi-site-origin-qht"><em>Configure Multi Site Origin</em></a> for a <em>quick how to</em> on this feature.</p>
+<p>see <a class="reference internal" href="quick_howto/multi_site.html#rl-multi-site-origin-qht"><span class="std std-ref">Configure Multi Site Origin</span></a> for a <em>quick how to</em> on this feature.</p>
</div>
<div class="section" id="ccr-profile-or-traffic-router-profile">
<span id="rl-ccr-profile"></span><h3>CCR Profile or Traffic Router Profile<a class="headerlink" href="#ccr-profile-or-traffic-router-profile" title="Permalink to this headline">�</a></h3>
@@ -1310,30 +1310,30 @@ http.parent_proxy.connect_attempts_timeout</td>
<div class="section" id="the-coverage-zone-file-and-asn-table">
<span id="rl-asn-czf"></span><h3>The Coverage Zone File and ASN Table<a class="headerlink" href="#the-coverage-zone-file-and-asn-table" title="Permalink to this headline">�</a></h3>
<p>The Coverage Zone File (CZF) should contain a cachegroup name to network prefix mapping in the form:</p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "coverageZones": {
- "cache-group-01": {
- "network6": [
- "1234:5678::\/64",
- "1234:5679::\/64"
- ],
- "network": [
- "192.168.8.0\/24",
- "192.168.9.0\/24"
- ]
- }
- "cache-group-02": {
- "network6": [
- "1234:567a::\/64",
- "1234:567b::\/64"
- ],
- "network": [
- "192.168.4.0\/24",
- "192.168.5.0\/24"
- ]
- }
- }
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"coverageZones"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cache-group-01"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1234:5678::\/64"</span><span class="p">,</span>
+ <span class="s2">"1234:5679::\/64"</span>
+ <span class="p">],</span>
+ <span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"192.168.8.0\/24"</span><span class="p">,</span>
+ <span class="s2">"192.168.9.0\/24"</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="s2">"cache-group-02"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1234:567a::\/64"</span><span class="p">,</span>
+ <span class="s2">"1234:567b::\/64"</span>
+ <span class="p">],</span>
+ <span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"192.168.4.0\/24"</span><span class="p">,</span>
+ <span class="s2">"192.168.5.0\/24"</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
</pre></div>
</div>
<p>The CZF is an input to the Traffic Control CDN, and as such does not get generated by Traffic Ops, but rather, it gets consumed by Traffic Router. Some popular IP management systems output a very similar file to the CZF but in stead of a cachegroup an ASN will be listed. Traffic Ops has the “Networks (ASNs)” view to aid with the conversion of files like that to a Traffic Control CZF file; this table is not used anywhere in Traffic Ops, but can be used to script the conversion using the API.</p>
@@ -1345,7 +1345,7 @@ http.parent_proxy.connect_attempts_timeout</td>
<p>Parameters are shared between profiles if the set of <code class="docutils literal"><span class="pre">{</span> <span class="pre">name,</span> <span class="pre">config_file,</span> <span class="pre">value</span> <span class="pre">}</span></code> is the same. To change a value in one profile but not in others, the parameter has to be removed from the profile you want to change it in, and a new parameter entry has to be created (<strong>Add Parameter</strong> button at the bottom of the Parameters view), and assigned to that profile. It is easy to create new profiles from the <strong>Misc > Profiles</strong> view - just use the <strong>Add/Copy Profile</strong> button at the bottom of the profile view to copy an existing profile to a new one. Profiles can be exported from one system and imported to another using the profile view as well. It makes no sense for a parameter to not be assigned to a single profile - in that case it really has no function. To find parameters like that
use the <strong>Parameters > Orphaned Parameters</strong> view. It is easy to create orphaned parameters by removing all profiles, or not assigning a profile directly after creating the parameter.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
-<p class="last"><a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><em>Profile Parameters</em></a> in the <em>Configuring Traffic Ops</em> section.</p>
+<p class="last"><a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><span class="std std-ref">Profile Parameters</span></a> in the <em>Configuring Traffic Ops</em> section.</p>
</div>
</div>
<div class="section" id="tools">
@@ -1421,30 +1421,30 @@ http.parent_proxy.connect_attempts_timeout</td>
<p>What we currently do is have 2 scripts, one to do hard drive configuration and one to do network configuration. Both are relatively specific to the environment they were created in, and both are <em>probably</em> wrong for other organizations, however they are currently living in the “misc” directory as examples of how to do things.</p>
<p>We trigger those in a %pre section in ks.cfg and they will write config files to /tmp. We will then include those files in the appropriate places using %pre.</p>
<p>For example this is a section of our ks.cfg file:</p>
-<div class="highlight-python"><div class="highlight"><pre>%include /mnt/stage2/ks_scripts/packages.txt
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">packages</span><span class="o">.</span><span class="n">txt</span>
-%pre
- python /mnt/stage2/ks_scripts/create_network_line.py
- bash /mnt/stage2/ks_scripts/drive_config.sh
-%end
+<span class="o">%</span><span class="n">pre</span>
+ <span class="n">python</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">create_network_line</span><span class="o">.</span><span class="n">py</span>
+ <span class="n">bash</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">drive_config</span><span class="o">.</span><span class="n">sh</span>
+<span class="o">%</span><span class="n">end</span>
</pre></div>
</div>
<p>These two scripts will then run _before_ anaconda sets up it’s internal structures, then a bit further up in the ks.cfg file (outside of the %pre %end block) we do an</p>
-<div class="highlight-python"><div class="highlight"><pre>%include /mnt/stage2/ks_scripts/password.cfg
-...
-%include /tmp/network_line
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">password</span><span class="o">.</span><span class="n">cfg</span>
+<span class="o">...</span>
+<span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">network_line</span>
-%include /tmp/drive_config
-...
+<span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">drive_config</span>
+<span class="o">...</span>
</pre></div>
</div>
<p>This snarfs up the contents and inlines them.</p>
<p>If you only have one kind of hardware on your CDN it is probably best to just put the drive config right in the ks.cfg.</p>
<p>If you have simple networking needs (we use bonded interfaces in most, but not all locations and we have several types of hardware meaning different ethernet interface names at the OS level etc.) then something like this:</p>
-<div class="highlight-python"><div class="highlight"><pre>#!/bin/bash
-source /mnt/stage2/ks_scripts/network.cfg
-echo "network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR --netmask=$NETMASK --gateway=$GATEWAY --ipv6gateway=$GATEWAY --nameserver=$NAMESERVER --mtu=$MTU --hostname=$HOSTNAME" >> /tmp/network.cfg
-# Note that this is an example and may not work at all.
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span>
+<span class="n">source</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">network</span><span class="o">.</span><span class="n">cfg</span>
+<span class="n">echo</span> <span class="s2">"network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR --netmask=$NETMASK --gateway=$GATEWAY --ipv6gateway=$GATEWAY --nameserver=$NAMESERVER --mtu=$MTU --hostname=$HOSTNAME"</span> <span class="o">>></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">network</span><span class="o">.</span><span class="n">cfg</span>
+<span class="c1"># Note that this is an example and may not work at all.</span>
</pre></div>
</div>
<p>You could also put this in the %pre section. Lots of ways to solve it.</p>
@@ -1486,7 +1486,7 @@ echo "network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR -
</div>
<div class="section" id="snapshot-crconfig">
<span id="rl-snapshot-crconfig"></span><span id="index-12"></span><h4>Snapshot CRConfig<a class="headerlink" href="#snapshot-crconfig" title="Permalink to this headline">�</a></h4>
-<p>Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig, and Traffic Router polls Traffic Monitor for the same file. This is necessary to ensure that Traffic Monitor sees configuration changes first, which helps to ensure that the health and state of caches and delivery services propagates properly to Traffic Router. See <a class="reference internal" href="#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> for more information on the CRConfig file.</p>
+<p>Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig, and Traffic Router polls Traffic Monitor for the same file. This is necessary to ensure that Traffic Monitor sees configuration changes first, which helps to ensure that the health and state of caches and delivery services propagates properly to Traffic Router. See <a class="reference internal" href="#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> for more information on the CRConfig file.</p>
<p>To create a new snapshot, use the <em>Tools > Snapshot CRConfig</em> menu:</p>
<blockquote>
<div><ol class="arabic">
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/traffic_portal.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_portal.html b/docs/latest/admin/traffic_portal.html
index 8cf934d..37f2249 100644
--- a/docs/latest/admin/traffic_portal.html
+++ b/docs/latest/admin/traffic_portal.html
@@ -106,7 +106,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Portal Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/traffic_router.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_router.html b/docs/latest/admin/traffic_router.html
index 33adb51..dad7e42 100644
--- a/docs/latest/admin/traffic_router.html
+++ b/docs/latest/admin/traffic_router.html
@@ -108,7 +108,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Router Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li>
@@ -185,9 +185,25 @@
<div role="main" class="document">
<div class="section" id="traffic-router-administration">
-<h1>Traffic Router Administration<a class="headerlink" href="#traffic-router-administration" title="Permalink to this headline">�</a></h1>
+<h1><a class="toc-backref" href="#contents">Traffic Router Administration</a><a class="headerlink" href="#traffic-router-administration" title="Permalink to this headline">�</a></h1>
+<div class="contents topic" id="contents">
+<p class="topic-title first">Contents</p>
+<ul class="simple">
+<li><a class="reference internal" href="#traffic-router-administration" id="id4">Traffic Router Administration</a><ul>
+<li><a class="reference internal" href="#installing-traffic-router" id="id5">Installing Traffic Router</a></li>
+<li><a class="reference internal" href="#configuring-traffic-router" id="id6">Configuring Traffic Router</a></li>
+<li><a class="reference internal" href="#dnssec" id="id7">DNSSEC</a></li>
+<li><a class="reference internal" href="#troubleshooting-and-log-files" id="id8">Troubleshooting and log files</a></li>
+<li><a class="reference internal" href="#event-log-file-format" id="id9">Event Log File Format</a></li>
+<li><a class="reference internal" href="#geolimit-failure-redirect-feature" id="id10">GeoLimit Failure Redirect feature</a></li>
+<li><a class="reference internal" href="#steering-feature" id="id11">Steering feature</a></li>
+<li><a class="reference internal" href="#https-for-http-type-delivery-services" id="id12">HTTPS for Http Type Delivery Services</a></li>
+</ul>
+</li>
+</ul>
+</div>
<div class="section" id="installing-traffic-router">
-<h2>Installing Traffic Router<a class="headerlink" href="#installing-traffic-router" title="Permalink to this headline">�</a></h2>
+<h2><a class="toc-backref" href="#contents">Installing Traffic Router</a><a class="headerlink" href="#installing-traffic-router" title="Permalink to this headline">�</a></h2>
<p>The following are requirements to ensure an accurate set up:</p>
<ul class="simple">
<li>CentOS 6</li>
@@ -211,7 +227,7 @@
<li><p class="first">Install a traffic router: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">install</span> <span class="pre">traffic_router</span></code>.</p>
</li>
<li><dl class="first docutils">
-<dt>Edit <code class="docutils literal"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><em>Configuration files</em></a></dt>
+<dt>Edit <code class="docutils literal"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><span class="std std-ref">Configuration files</span></a></dt>
<dd><p class="first"># traffic_monitor.properties: url that should normally point to this file
traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.properties</p>
<p class="last"># Frequency for reloading this file
@@ -221,7 +237,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</li>
<li><p class="first">Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code>, and test lookups with dig and curl against that server.</p>
</li>
-<li><p class="first">Snapshot CRConfig; See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><em>Snapshot CRConfig</em></a></p>
+<li><p class="first">Snapshot CRConfig; See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><span class="std std-ref">Snapshot CRConfig</span></a></p>
</li>
</ol>
<div class="admonition note">
@@ -233,7 +249,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</ol>
</div>
<div class="section" id="configuring-traffic-router">
-<h2>Configuring Traffic Router<a class="headerlink" href="#configuring-traffic-router" title="Permalink to this headline">�</a></h2>
+<h2><a class="toc-backref" href="#contents">Configuring Traffic Router</a><a class="headerlink" href="#configuring-traffic-router" title="Permalink to this headline">�</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Starting with Traffic Router 1.5, many of the configuration files under <code class="docutils literal"><span class="pre">/opt/traffic_router/conf</span></code> are only needed to override the default configuration values for Traffic Router. Most of the given default values will work well for any CDN. Critical values that must be changed are hostnames and credentials for communicating with other Traffic Control components such as Traffic Ops and Traffic Monitor.</p>
@@ -242,7 +258,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
<p class="first admonition-title">Note</p>
<p class="last">Pre-existing installations having configuration files in <code class="docutils literal"><span class="pre">/opt/traffic_router/conf</span></code> will still be used and honored for Traffic Router 1.5 and onward.</p>
</div>
-<p>For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><em>Snapshot CRConfig</em></a> for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> for parameters that influence the behavior of Traffic Router via the CRConfig.</p>
+<p>For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><span class="std std-ref">Snapshot CRConfig</span></a> for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> for parameters that influence the behavior of Traffic Router via the CRConfig.</p>
<div class="section" id="configuration-files">
<span id="rl-tr-config-files"></span><h3>Configuration files<a class="headerlink" href="#configuration-files" title="Permalink to this headline">�</a></h3>
<table border="1" class="docutils">
@@ -359,7 +375,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</div>
</div>
<div class="section" id="dnssec">
-<span id="rl-tr-dnssec"></span><h2>DNSSEC<a class="headerlink" href="#dnssec" title="Permalink to this headline">�</a></h2>
+<span id="rl-tr-dnssec"></span><h2><a class="toc-backref" href="#contents">DNSSEC</a><a class="headerlink" href="#dnssec" title="Permalink to this headline">�</a></h2>
<div class="section" id="overview">
<h3>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">�</a></h3>
<p>Domain Name System Security Extensions (DNSSEC) is a set of extensions to DNS that provides a cryptographic mechanism for resolvers to verify the authenticity of responses served by an authoritative DNS server.</p>
@@ -368,7 +384,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</div>
<div class="section" id="operation">
<h3>Operation<a class="headerlink" href="#operation" title="Permalink to this headline">�</a></h3>
-<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> documentation for more information.</p>
+<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> documentation for more information.</p>
<p>Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each delivery service’s zone (e.g.: mydeliveryservice.cdn.kabletown.net) for every valid key that exists, in addition to the CDN TLD’s zone. A DS record is generated from each zone’s KSK and is placed in the CDN TLD’s zone (e.g.: cdn.kabletown.net); the DS record for the CDN TLD must be placed in its parent zone, which is not managed by Traffic Control.</p>
<p>The DNSKEY to DS record relationship allows resolvers to validate signatures across zone delegation points; with Traffic Control, we control all delegation points below the CDN’s TLD, <strong>however, the DS record for the CDN TLD must be placed in the parent zone (e.g.: kabletown.net), which is not managed by Traffic Control</strong>. As such, the DS record (available in the Traffic Ops DNSSEC administration UI) must be placed in the parent zone prior to enabling DNSSEC, and prior to generating a new CDN KSK. Based on your deployment’s DNS configuration, this might be a manual process or it might be automated; either way, extreme care and diligence must be taken and knowledge of the management of the upstream zone is imperative for a successful DNSSEC deployment.</p>
</div>
@@ -378,11 +394,11 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</div>
</div>
<div class="section" id="troubleshooting-and-log-files">
-<h2>Troubleshooting and log files<a class="headerlink" href="#troubleshooting-and-log-files" title="Permalink to this headline">�</a></h2>
+<h2><a class="toc-backref" href="#contents">Troubleshooting and log files</a><a class="headerlink" href="#troubleshooting-and-log-files" title="Permalink to this headline">�</a></h2>
<p>Traffic Router log files are in <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log</span></code>, and Tomcat log files are in <code class="docutils literal"><span class="pre">/opt/tomcat/logs</span></code>. Application related logging is in <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log/traffic_router.log</span></code>, while access logs are written to <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log/access.log</span></code>.</p>
</div>
<div class="section" id="event-log-file-format">
-<h2>Event Log File Format<a class="headerlink" href="#event-log-file-format" title="Permalink to this headline">�</a></h2>
+<h2><a class="toc-backref" href="#contents">Event Log File Format</a><a class="headerlink" href="#event-log-file-format" title="Permalink to this headline">�</a></h2>
<div class="section" id="summary">
<h3>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">�</a></h3>
<p>All access events to Traffic Router are logged to the file <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log/access.log</span></code>
@@ -393,8 +409,8 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="sample-message">
<h3>Sample Message<a class="headerlink" href="#sample-message" title="Permalink to this headline">�</a></h3>
<p>Items within brackets below are detailed under the HTTP and DNS sections</p>
-<div class="highlight-python"><div class="highlight"><pre>144140678.000 qtype=DNS chi=192.168.10.11 ttms=789 [Fields Specific to the DNS request] rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the DNS result]
-144140678.000 qtype=HTTP chi=192.168.10.11 ttms=789 [Fields Specific to the HTTP request] rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the HTTP result]
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields
</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">result</span><span class="p">]</span>
+<span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">HTTP</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <sp
an class="n">the</span> <span class="n">HTTP</span> <span class="n">result</span><span class="p">]</span>
</pre></div>
</div>
<div class="admonition note">
@@ -533,7 +549,7 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="http-specifics">
<h3>HTTP Specifics<a class="headerlink" href="#http-specifics" title="Permalink to this headline">�</a></h3>
<p>Sample Message</p>
-<div class="highlight-python"><div class="highlight"><pre>1452197640.936 qtype=HTTP chi=69.241.53.218 url="http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" pssc=302 ttms=0 rurl="http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8" rh="Accept: */*" rh="myheader: asdasdasdasfasg"
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1452197640.936</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">69.241</span><span class="o">.</span><span class="mf">53.218</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-&
quot;</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">0</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"Accept: */*"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"myheader: asdasdasdasfasg"</span>
</pre></div>
</div>
<p><strong>Request Fields</strong></p>
@@ -593,7 +609,7 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="dns-specifics">
<h3>DNS Specifics<a class="headerlink" href="#dns-specifics" title="Permalink to this headline">�</a></h3>
<p>Sample Message</p>
-<div class="highlight-python"><div class="highlight"><pre>144140678.000 qtype=DNS chi=192.168.10.11 ttms=123 xn=65535 fqdn=www.example.com. type=A class=IN ttl=12345 rcode=NOERROR rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" ans="192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">123</span> <span class="n">xn</span><span class="o">=</span><span class="mi">65535</span> <span class="n">fqdn</span><span class="o">=</span><span class="n">www</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">.</span> <span class="nb">type</span><span class="o">=</span><span class="n">A</span> <span class="n">class</span><span class="o">=</span><span class="n">IN</span> <span class="n">ttl</span><span class="o">=</span><span class="mi">12345</span> <span class="n">rcode</span><span class="o">=</span><span class="n">NOERRO
R</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">ans</span><span class="o">=</span><span class="s2">"192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"</span>
</pre></div>
</div>
<p><strong>Request Fields</strong></p>
@@ -672,7 +688,7 @@ NXDOMAIN (the domain/name requested does not exist)</td>
</div>
</div>
<div class="section" id="geolimit-failure-redirect-feature">
-<span id="rl-tr-ngb"></span><h2>GeoLimit Failure Redirect feature<a class="headerlink" href="#geolimit-failure-redirect-feature" title="Permalink to this headline">�</a></h2>
+<span id="rl-tr-ngb"></span><h2><a class="toc-backref" href="#contents">GeoLimit Failure Redirect feature</a><a class="headerlink" href="#geolimit-failure-redirect-feature" title="Permalink to this headline">�</a></h2>
<div class="section" id="id1">
<h3>Overview<a class="headerlink" href="#id1" title="Permalink to this headline">�</a></h3>
<p>This feature is also called ‘National GeoBlock’ feature which is short for ‘NGB’ feature. In this section, the acronym ‘NGB’ will be used for this feature.</p>
@@ -693,7 +709,7 @@ NXDOMAIN (the domain/name requested does not exist)</td>
</div>
</div>
<div class="section" id="steering-feature">
-<span id="rl-tr-steering"></span><h2>Steering feature<a class="headerlink" href="#steering-feature" title="Permalink to this headline">�</a></h2>
+<span id="rl-tr-steering"></span><h2><a class="toc-backref" href="#contents">Steering feature</a><a class="headerlink" href="#steering-feature" title="Permalink to this headline">�</a></h2>
<div class="section" id="id2">
<h3>Overview<a class="headerlink" href="#id2" title="Permalink to this headline">�</a></h3>
<p>A Steering delivery service is a delivery service that is used to “steer” traffic to other delivery services. A Steering delivery service will have target delivery services configured for it with weights assigned to them. Traffic Router uses the weights to make a consistent hash ring which it then uses to make sure that requests are routed to a target based on the configured weights. This consistent hash ring is separate from the consistent hash ring used in cache selection.</p>
@@ -725,6 +741,109 @@ NXDOMAIN (the domain/name requested does not exist)</td>
<p>For more information see the <a class="reference external" href="quick_howto/steering.html">steering how-to guide</a>.</p>
</div>
</div>
+<div class="section" id="https-for-http-type-delivery-services">
+<h2><a class="toc-backref" href="#contents">HTTPS for Http Type Delivery Services</a><a class="headerlink" href="#https-for-http-type-delivery-services" title="Permalink to this headline">�</a></h2>
+<p>Starting with version 1.7 Traffic Router added the ability to allow https traffic between itself and clients on a per http type delivery service basis.</p>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">The establishing of an HTTPS connection is much more computationally demanding than an HTTP connection.
+Since each client will in turn get redirected to ATS, Traffic Router is most always creating a new HTTPS connection for all HTTPS traffic.
+It is likely to mean that an existing Traffic Router will have some decrease in performance depending on the amount of https traffic you want to support
+As noted for DNSSEC, you may need to plan to scale Traffic Router vertically and/or horizontally to handle the new load</p>
+</div>
+<p>The summary for setting up https is to:</p>
+<ol class="arabic simple">
+<li>Select one of ‘https’, ‘http and https’, or ‘http to https’ for the delivery service</li>
+<li>Generate private keys for the delivery service using a wildcard domain such as <code class="docutils literal"><span class="pre">*.my-delivery-service.my-cdn.example.com</span></code></li>
+<li>Obtain and import signed certificate chain</li>
+<li>Snapshot CR Config</li>
+</ol>
+<p>Clients may make HTTPS requests delivery services only after Traffic Router receives the certificate chain from Traffic Ops and the new CR Config.</p>
+<div class="section" id="protocol-options">
+<h3>Protocol Options<a class="headerlink" href="#protocol-options" title="Permalink to this headline">�</a></h3>
+<dl class="docutils">
+<dt><em>https only</em></dt>
+<dd>Traffic Router will only redirect (send a 302) to clients communicating with a secure connection, all other clients will receive a 503</dd>
+<dt><em>http and https</em></dt>
+<dd>Traffic Router will redirect both secure and non-secure clients</dd>
+<dt><em>http to https</em></dt>
+<dd>Traffic Router will redirect non-secure clients with a 302 and a location that is secure (i.e. starting with ‘https’ instead of ‘http’), secure clients will remain on https</dd>
+<dt><em>http</em></dt>
+<dd>Any secure client will get an SSL handshake error. Non-secure clients will experience the same behavior as prior to 1.7</dd>
+</dl>
+</div>
+<div class="section" id="certificate-retrieval">
+<h3>Certificate Retrieval<a class="headerlink" href="#certificate-retrieval" title="Permalink to this headline">�</a></h3>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">If you have https delivery services in your CDN, Traffic Router will not accept <strong>any</strong> connections until it is able to
+fetch certificates from Traffic Ops and load them into memory. Traffic Router does not persist certificates to the java keystore or anywhere else.</p>
+</div>
+<p>Traffic Router fetches certificates into memory:</p>
+<ul class="simple">
+<li>At startup time</li>
+<li>When it receives a new CR Config</li>
+<li>Once an hour from whenever the most recent of the last of the above occurred</li>
+</ul>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">To adjust the frequency when Traffic Router fetches certificates add the parameter ‘certificates.polling.interval’ to CR Config and
+setting it to the desired time in milliseconds.</p>
+</div>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Taking a snapshot of CR Config may be used at times to avoid waiting the entire polling cycle for a new set of certificates.</p>
+</div>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">If a snapshot of CR Config is made that involves a delivery service missing its certificates, Traffic Router will ignore <strong>ALL</strong> changes in that CR-Config
+until one of the following occurs:
+* It receives certificates for that delivery service
+* Another snapshot of CR Config is created and the delivery service without certificates is changed so it’s HTTP protocol is set to ‘http’</p>
+</div>
+</div>
+<div class="section" id="certificate-chain-ordering">
+<h3>Certificate Chain Ordering<a class="headerlink" href="#certificate-chain-ordering" title="Permalink to this headline">�</a></h3>
+<p>The ordering of certificates within the certificate bundle matters. It must be:</p>
+<ol class="arabic simple">
+<li>Primary Certificate (e.g. the one created for <code class="docutils literal"><span class="pre">*.my-delivery-service.my-cdn.example.com</span></code>)</li>
+<li>Intermediate Certificate(s)</li>
+<li>Root Certificate from CA (optional)</li>
+</ol>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">If something is wrong with the certificate chain (e.g. the order of the certificates is backwards or for the wrong domain) the
+client will get an SSL handshake. Inspection of /opt/tomcat/logs/catalina.out is likely to yield information to reveal this.</p>
+</div>
+<p>To see the ordering of certificates you may have to manually split up your certificate chain and use openssl on each individual certificate</p>
+</div>
+<div class="section" id="suggested-way-of-setting-up-an-https-delivery-service">
+<h3>Suggested Way of Setting up an HTTPS Delivery Service<a class="headerlink" href="#suggested-way-of-setting-up-an-https-delivery-service" title="Permalink to this headline">�</a></h3>
+<p>Do the following in Traffic Ops:</p>
+<ol class="arabic simple">
+<li>Select one of ‘https’, ‘http and https’, or ‘http to https’ for the protocol field of a delivery service and click ‘Save’.</li>
+<li>Click ‘Manage SSL Keys’.</li>
+<li>Click ‘Generate New Keys’.</li>
+<li>Copy the contents of the Certificate Signing Request field and save it locally.</li>
+<li>Click ‘Load Keys’.</li>
+<li>Select ‘http’ for the protocol field of the delivery service and click ‘Save’ (to avoid preventing other CR Config updates from being blocked by Traffic Router)</li>
+<li>Follow your standard procedure for obtaining your signed certificate chain from a CA.</li>
+<li>After receiving your certificate chain import it into Traffic Ops.</li>
+<li>Edit the delivery service.</li>
+<li>Restore your original choice for the protocol field and click save.</li>
+<li>Click ‘Manage SSL Keys’.</li>
+<li>Click ‘Paste Existing Keys’.</li>
+<li>Paste the certificate chain into the CRT field.</li>
+<li>Click ‘Load Keys’.</li>
+<li>Take a new snapshot of CR Config.</li>
+</ol>
+<p>Once this is done you should be able to test you are getting correctly redirected by Traffic Router using curl commands to https destinations on your delivery service.</p>
+<p>A new testing tool was created for load testing traffic router, it allows you to generate requests from your local box to multiple delivery services of a single cdn.
+You can control which cdn, delivery services, how many transactions per delivery service, and how many concurrent requests.
+During the test it will provide feedback about request latency and transactions per second.</p>
+<p>While it is running it is suggested that you monitor your Traffic Router nodes for memory and CPU utilization.</p>
+</div>
+</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/traffic_server.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_server.html b/docs/latest/admin/traffic_server.html
index 328aa14..490abfe 100644
--- a/docs/latest/admin/traffic_server.html
+++ b/docs/latest/admin/traffic_server.html
@@ -110,7 +110,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Server Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a></li>
</ul>
@@ -202,7 +202,7 @@
<dl class="docutils">
<dt><strong>traffic_ops_ort.pl</strong></dt>
<dd><p class="first">The traffic_ops_ort.pl should be installed on all caches (by puppet or other non Traffic Ops means), usually in /opt/ort. It is used to do initial install of the config files when the cache is being deployed, and to keep the config files up to date when the cache is already in service. The usage message of the script is shown below:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ sudo ./traffic_ops_ort.pl syncds warn https://to.cdn.kabletown.net
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ sudo ./traffic_ops_ort.pl syncds warn https://to.cdn.kabletown.net
Thu May 26 15:52:11 UTC 2016
====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
Usage: ./traffic_ops_ort.pl <Mode> <Log_Level> <Traffic_Ops_URL> <Traffic_Ops_Login> [optional flags]
@@ -226,11 +226,11 @@ $
</pre></div>
</div>
<p>For initial configuration or when major changes (like a Profile change) need to be made, run the script in “badass mode”. All required rpm packages will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted. Example run below:</p>
-<div class="highlight-python"><div class="highlight"><pre>run here
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">run</span> <span class="n">here</span>
</pre></div>
</div>
<p>For “every day changes” such as adding deliveryservices or changing records.config parameters caches should run the script in “syncds” mode out of cron. Example crontab entry:</p>
-<div class="highlight-python"><div class="highlight"><pre>*/15 * * * * /opt/ort/traffic_ops_ort.pl syncds warn https://traffops.kabletown.net admin:password > /tmp/ort/syncds.log 2>&1
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span> <span class="n">syncds</span> <span class="n">warn</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">traffops</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="n">admin</span><span class="p">:</span><span class="n">password</span> <span class="o">></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">syncds</span><span class="o">.</span
><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
</pre></div>
</div>
<div class="last admonition note">
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/traffic_stats.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_stats.html b/docs/latest/admin/traffic_stats.html
index 904edce..a70274a 100644
--- a/docs/latest/admin/traffic_stats.html
+++ b/docs/latest/admin/traffic_stats.html
@@ -109,7 +109,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Stats Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a></li>
@@ -186,7 +186,7 @@
<div class="section" id="traffic-stats-administration">
<h1>Traffic Stats Administration<a class="headerlink" href="#traffic-stats-administration" title="Permalink to this headline">�</a></h1>
-<p>Traffic Stats actually consists of three seperate components: Traffic Stats, InfluxDB, and Grafana. See below for information on installing and configuring each component as well as configuring the integration between the three and Traffic Ops.</p>
+<p>Traffic Stats consists of three seperate components: Traffic Stats, InfluxDB, and Grafana. See below for information on installing and configuring each component as well as configuring the integration between the three and Traffic Ops.</p>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">�</a></h2>
<p><strong>Installing Traffic Stats:</strong></p>
@@ -199,12 +199,12 @@
</div></blockquote>
<p><strong>Installing InfluxDB:</strong></p>
<blockquote>
-<div><p><strong>As of Traffic Stats 1.4.0, InfluxDb 0.9.6 or higher is required. For InfluxDb versions less than 0.9.6 use Traffic Stats 1.3.0</strong></p>
-<p>In order to store traffic stats data you will need to install InfluxDB. It is recommended InfluxDB be installed in a 3 server cluster; VMs are acceptable. The documentation for installing InfluxDB can be found on the InfluxDB <a class="reference external" href="https://docs.influxdata.com/influxdb/latest/introduction/installation/">website</a>.</p>
+<div><p><strong>As of Traffic Stats 1.8.0, InfluxDb 1.0.0 or higher is required. For InfluxDb versions less than 1.0.0 use Traffic Stats 1.7.x</strong></p>
+<p>In order to store traffic stats data you will need to install <a class="reference external" href="https://docs.influxdata.com/influxdb/latest/introduction/installation/">InfluxDB</a>. While not required, it is recommended to use some sort of high availability option like <a class="reference external" href="https://portal.influxdata.com/">Influx enterprise</a>, <a class="reference external" href="https://github.com/influxdata/influxdb-relay">Influxdb Relay</a>, or another <a class="reference external" href="https://www.influxdata.com/high-availability/">high availability option</a>.</p>
</div></blockquote>
<p><strong>Installing Grafana:</strong></p>
<blockquote>
-<div>Grafana is used to display Traffic Stats/InfluxDB data in Traffic Ops. Grafana is typically run on the same server as Traffic Stats but this is not a requirement. Grafana can be installed on any server that can access InfluxDB and be accessed by Traffic Ops. Documentation on installing Grafana can be found <a class="reference external" href="http://docs.grafana.org/installation/">here</a>.</div></blockquote>
+<div>Grafana is used to display Traffic Stats/InfluxDB data in Traffic Ops. Grafana is typically run on the same server as Traffic Stats but this is not a requirement. Grafana can be installed on any server that can access InfluxDB and can be accessed by Traffic Ops. Documentation on installing Grafana can be found on the <a class="reference external" href="http://docs.grafana.org/installation/">Grafana website</a>.</div></blockquote>
</div>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">�</a></h2>
@@ -219,26 +219,27 @@ The following values need to be configured:</p>
<li><em>toUrl:</em> The URL of the Traffic Ops server used by Traffic Stats</li>
<li><em>influxUser:</em> The user to use when connecting to InfluxDB (if configured on InfluxDB, else leave default)</li>
<li><em>influxPassword:</em> That password to use when connecting to InfluxDB (if configured, else leave blank)</li>
-<li><em>polling interval:</em> The interval at which Traffic Monitor is polled and stats are stored in InfluxDB</li>
+<li><em>pollingInterval:</em> The interval at which Traffic Monitor is polled and stats are stored in InfluxDB</li>
<li><em>statusToMon:</em> The status of Traffic Monitor to poll (poll ONLINE or OFFLINE traffic monitors)</li>
<li><em>seelogConfig:</em> The absolute path of the seelong config file</li>
<li><em>dailySummaryPollingInterval:</em> The interval, in seconds, at which Traffic Stats checks to see if daily stats need to be computed and stored.</li>
<li><em>cacheRetentionPolicy:</em> The default retention policy for cache stats</li>
<li><em>dsRetentionPolicy:</em> The default retention policy for deliveryservice stats</li>
<li><em>dailySummaryRetentionPolicy:</em> The retention policy to be used for the daily stats</li>
+<li><em>influxUrls:</em> An array of influxdb hosts for Traffic Stats to write stats to.</li>
</ul>
</div></blockquote>
</div></blockquote>
<p><strong>Configuring InfluxDB:</strong></p>
<blockquote>
-<div><p>It is HIGHLY recommended that InfluxDB be configured for clustering. Documentation on clustering configuration can be found on the clustering page of the <a class="reference external" href="https://docs.influxdata.com/influxdb/latest/clustering/">InfluxDB Website</a>.</p>
-<p>Once InfluxDB is installed and clustering is configured, Databases and Retention Policies need to be created. Traffic Stats writes to three different databases: cache_stats, deliveryservice_stats, and daily_stats. More information about the databases and what data is stored in each can be found on the <a class="reference external" href="../overview/traffic_stats.html">overview</a> page.</p>
-<p>To easily create databases, retention policies, and continuous queries, run create_ts_databases.go from the influxdb_tools directory. See the <a class="reference external" href="traffic_stats.html#influxdb-tools">InfluxDb Tools</a> section below for more information.</p>
+<div><p>As mentioned above, it is recommended that InfluxDb be running in some sort of high availability configuration. There are several ways to achieve high availabilty so it is best to consult the high availability options on the <a class="reference external" href="https://www.influxdata.com/high-availability/">InfuxDB website</a>.</p>
+<p>Once InfluxDB is installed and configured, databases and retention policies need to be created. Traffic Stats writes to three different databases: cache_stats, deliveryservice_stats, and daily_stats. More information about the databases and what data is stored in each can be found on the <a class="reference external" href="../overview/traffic_stats.html">overview</a> page.</p>
+<p>To easily create databases, retention policies, and continuous queries, run create_ts_databases from the /opt/traffic_stats/influxdb_tools directory on your Traffic Stats server. See the <a class="reference external" href="traffic_stats.html#influxdb-tools">InfluxDb Tools</a> section below for more information.</p>
</div></blockquote>
<p><strong>Configuring Grafana:</strong></p>
<blockquote>
<div><blockquote>
-<div><p>In Traffic Ops the Health -> Graph View tab can be configured to display grafana graphs using influxDb data. In order for this to work correctly, you will need two things 1) a parameter added to traffic ops with the graph URL (we will discuss later) and 2) the graphs created in grafana. See below for how to create some simple graphs in grafana. These instructions assume that InfluxDB has been installed and conifugred and that data has been written to it. If this is not true, you will not see any graphs.</p>
+<div><p>In Traffic Ops the Health -> Graph View tab can be configured to display grafana graphs using influxDb data. In order for this to work correctly, you will need two things 1) a parameter added to traffic ops with the graph URL (more information below) and 2) the graphs created in grafana. See below for how to create some simple graphs in grafana. These instructions assume that InfluxDB has been configured and that data has been written to it. If this is not true, you will not see any graphs.</p>
<ul>
<li><p class="first">Login to grafana as an admin user <a class="reference external" href="http://grafana_url:3000/login">http://grafana_url:3000/login</a></p>
</li>
@@ -319,8 +320,8 @@ The following values need to be configured:</p>
</table>
</div></blockquote>
</div>
-<div class="section" id="id1">
-<h2>InfluxDb Tools<a class="headerlink" href="#id1" title="Permalink to this headline">�</a></h2>
+<div class="section" id="id2">
+<h2>InfluxDb Tools<a class="headerlink" href="#id2" title="Permalink to this headline">�</a></h2>
<p>Under the Traffic Stats source directory there is a directory called influxdb_tools. These tools are meant to be used as one-off scripts to help a user quickly get new databases and continuous queries setup in influxdb.
They are specific for traffic stats and are not meant to be generic to influxdb. Below is an brief description of each script along with how to use it.</p>
<dl class="docutils">
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/traffic_vault.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_vault.html b/docs/latest/admin/traffic_vault.html
index 5ce808f..c86266b 100644
--- a/docs/latest/admin/traffic_vault.html
+++ b/docs/latest/admin/traffic_vault.html
@@ -111,7 +111,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Vault Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a></li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/basics/cache_revalidation.html
----------------------------------------------------------------------
diff --git a/docs/latest/basics/cache_revalidation.html b/docs/latest/basics/cache_revalidation.html
index 8f35527..84b7f54 100644
--- a/docs/latest/basics/cache_revalidation.html
+++ b/docs/latest/basics/cache_revalidation.html
@@ -83,7 +83,7 @@
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Cache Control Headers and Revalidation</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Cache Control Headers and Revalidation</a></li>
</ul>
</li>
</ul>
@@ -187,49 +187,49 @@
<div class="section" id="cache-control-headers-and-revalidation">
<span id="index-0"></span><h1>Cache Control Headers and Revalidation<a class="headerlink" href="#cache-control-headers-and-revalidation" title="Permalink to this headline">�</a></h1>
<p>The <a class="reference external" href="https://www.ietf.org/rfc/rfc2616.txt">HTTP/1.1 spec</a> allows for origin servers and clients to influence how caches treat their requests and responses. By default, the Traffic Control CDN will honor cache control headers. Most commonly, origin servers will tell the downstream caches how long a response can be cached:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Cache-Control: max-age=86400
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">86400</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
<p>In the above response, the origin server tells downstream caching systems that the maximum time to cache this response for is 86400 seconds. The origin can also add a <code class="docutils literal"><span class="pre">Expires:</span></code> header, explicitly telling the cache the time this response is to be expired. When a response is expired it usually doesn’t get deleted from the cache, but, when a request comes in that would have hit on this response if it was not expired, the cache <em>revalidates</em> the response. In stead of requesting the object again from the origin server, the cache will send a request to the origin indicating what version of the response it has, and asking if it has changed. If it changed, the server will send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> response, with the new data. If it has not changed, the origin server will send back a <code class="docutils literal"><span class="pre">304</spa
n> <span class="pre">Not</span> <span class="pre">Modified</span></code> response indicating the response is still valid, and that the cache can reset the timer on the response expiration. To indicate what version the client (cache) has it will add an <code class="docutils literal"><span class="pre">If-Not-Modified-Since:</span></code> header, or an <code class="docutils literal"><span class="pre">If-None-Match:</span></code> header. For example, in the <code class="docutils literal"><span class="pre">If-None-Match:</span></code> case, the origin will send and <code class="docutils literal"><span class="pre">ETag</span></code> header that uniquely identifies the response. The client can use that in an revalidation request like:</p>
-<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
-If-None-Match: "1aa008f-2d-50a3559482cc0"
-Host: www.origin.com
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">If</span><span class="o">-</span><span class="kc">None</span><span class="o">-</span><span class="n">Match</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
<p>If the content has changed (meaning, the new response would not have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code>, like:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 18 Dec 2014 3:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50aa00feadd"
-Cache-Control: max-age=604800
-Content-Length: 49
-Connection: close
-Content-Type: text/html; charset=UTF-8
-
-<html><body>This is NOT a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50aa00feadd"</span>
+<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">604800</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">49</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">NOT</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
<p>If the Content did not change (meaning, the response would have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code>, like:</p>
-<div class="highlight-python"><div class="highlight"><pre>304 Not Modified
-Date: Sun, 18 Dec 2014 3:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Cache-Control: max-age=604800
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">304</span> <span class="n">Not</span> <span class="n">Modified</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">604800</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
</pre></div>
</div>
<p>Note that the 304 response only has headers, not the data.</p>
[42/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/traffic_ops_using.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/traffic_ops_using.html b/docs/1.7.0/admin/traffic_ops_using.html
index 6cc010c..6c1a40e 100644
--- a/docs/1.7.0/admin/traffic_ops_using.html
+++ b/docs/1.7.0/admin/traffic_ops_using.html
@@ -104,7 +104,7 @@
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Using Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
@@ -208,16 +208,16 @@
<td>A real time view into the main performance indicators of the CDNs managed by Traffic Control.
This view is sourced directly by the Traffic Monitor data and is updated every 10 seconds.
This is the default screen of Traffic Ops.
-See <a class="reference internal" href="#rl-health-table"><em>The Health Table</em></a> for details.</td>
+See <a class="reference internal" href="#rl-health-table"><span class="std std-ref">The Health Table</span></a> for details.</td>
</tr>
<tr class="row-odd"><td>Graph View</td>
<td>A real graphical time view into the main performance indicators of the CDNs managed by Traffic Control.
This view is sourced by the Traffic Monitor data and is updated every 10 seconds.
On loading, this screen will show a history of 24 hours of data from Traffic Stats
-See <a class="reference internal" href="#rl-health-graph"><em>Graph View</em></a> for details.</td>
+See <a class="reference internal" href="#rl-health-graph"><span class="std std-ref">Graph View</span></a> for details.</td>
</tr>
<tr class="row-even"><td>Server Checks</td>
-<td>A table showing the results of the periodic check extension scripts that are run. See <a class="reference internal" href="#rl-server-checks"><em>Server Checks</em></a></td>
+<td>A table showing the results of the periodic check extension scripts that are run. See <a class="reference internal" href="#rl-server-checks"><span class="std std-ref">Server Checks</span></a></td>
</tr>
<tr class="row-odd"><td>Daily Summary</td>
<td>A graph displaying the daily peaks of bandwidth, overall bytes served per day, and overall bytes served since initial installation
@@ -259,7 +259,7 @@ per CDN.</td>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Upload Server CSV</td>
-<td>Bulk add of servers from a csv file. See <a class="reference internal" href="#rl-bulkserver"><em>Bulk Upload Server</em></a></td>
+<td>Bulk add of servers from a csv file. See <a class="reference internal" href="#rl-bulkserver"><span class="std std-ref">Bulk Upload Server</span></a></td>
</tr>
</tbody>
</table>
@@ -278,7 +278,7 @@ per CDN.</td>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Global Profile</td>
-<td>The table of global parameters. See <a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><em>Profile Parameters</em></a>. This is where you Create/Read/Update/Delete parameters in the Global profile</td>
+<td>The table of global parameters. See <a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><span class="std std-ref">Profile Parameters</span></a>. This is where you Create/Read/Update/Delete parameters in the Global profile</td>
</tr>
<tr class="row-odd"><td>All Cache Groups</td>
<td>The table of all parameters <em>that are assgined to a cachegroup</em> - this may be slow to pull up, as there can be thousands of parameters.</td>
@@ -309,19 +309,19 @@ per CDN.</td>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Generate ISO</td>
-<td>Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See <a class="reference internal" href="#rl-generate-iso"><em>Generate ISO</em></a></td>
+<td>Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See <a class="reference internal" href="#rl-generate-iso"><span class="std std-ref">Generate ISO</span></a></td>
</tr>
<tr class="row-odd"><td>Queue Updates</td>
-<td>Send Updates to the caches. See <a class="reference internal" href="#rl-queue-updates"><em>Queue Updates and Snapshot CRConfig</em></a></td>
+<td>Send Updates to the caches. See <a class="reference internal" href="#rl-queue-updates"><span class="std std-ref">Queue Updates and Snapshot CRConfig</span></a></td>
</tr>
<tr class="row-even"><td>DB Dump</td>
<td>Backup the Database to a .sql file.</td>
</tr>
<tr class="row-odd"><td>Snapshot CRConfig</td>
-<td>Send updates to the Traffic Monitor / Traffic Router servers. See <a class="reference internal" href="#rl-queue-updates"><em>Queue Updates and Snapshot CRConfig</em></a></td>
+<td>Send updates to the Traffic Monitor / Traffic Router servers. See <a class="reference internal" href="#rl-queue-updates"><span class="std std-ref">Queue Updates and Snapshot CRConfig</span></a></td>
</tr>
<tr class="row-even"><td>Invalidate Content</td>
-<td>Invalidate or purge content from all caches in the CDN. See <a class="reference internal" href="#rl-purge"><em>Invalidate Content</em></a></td>
+<td>Invalidate or purge content from all caches in the CDN. See <a class="reference internal" href="#rl-purge"><span class="std std-ref">Invalidate Content</span></a></td>
</tr>
<tr class="row-odd"><td>Manage DNSSEC keys</td>
<td>Manage DNSSEC Keys for a chosen CDN.</td>
@@ -349,10 +349,10 @@ per CDN.</td>
<td>Create/Read/Update/Delete users</td>
</tr>
<tr class="row-even"><td>Profiles</td>
-<td>Create/Read/Update/Delete profiles. See <a class="reference internal" href="#rl-working-with-profiles"><em>Parameters and Profiles</em></a></td>
+<td>Create/Read/Update/Delete profiles. See <a class="reference internal" href="#rl-working-with-profiles"><span class="std std-ref">Parameters and Profiles</span></a></td>
</tr>
<tr class="row-odd"><td>Networks(ASNs)</td>
-<td>Create/Read/Update/Delete Autonomous System Numbers See <a class="reference internal" href="#rl-asn-czf"><em>The Coverage Zone File and ASN Table</em></a></td>
+<td>Create/Read/Update/Delete Autonomous System Numbers See <a class="reference internal" href="#rl-asn-czf"><span class="std std-ref">The Coverage Zone File and ASN Table</span></a></td>
</tr>
<tr class="row-even"><td>Hardware</td>
<td>Get detailed hardware information (note: this should be moved to a Traffic Ops Extension)</td>
@@ -554,7 +554,7 @@ must have an ssh key on the edge servers.</td>
<td>A unique string that identifies this delivery service.</td>
</tr>
<tr class="row-odd"><td>Content Routing Type</td>
-<td>The type of content routing this delivery service will use. See <a class="reference internal" href="#rl-ds-types"><em>Delivery Service Types</em></a>.</td>
+<td>The type of content routing this delivery service will use. See <a class="reference internal" href="#rl-ds-types"><span class="std std-ref">Delivery Service Types</span></a>.</td>
</tr>
<tr class="row-even"><td>Protocol</td>
<td><p class="first">The protocol to serve this delivery service to the clients with:</p>
@@ -569,7 +569,7 @@ must have an ssh key on the edge servers.</td>
<td>The DSCP value to mark IP packets to the client with.</td>
</tr>
<tr class="row-even"><td>Signed URLs</td>
-<td>Use Signed URLs? See <a class="reference internal" href="#rl-signed-urls"><em>Token Based Authentication</em></a>.</td>
+<td>Use Signed URLs? See <a class="reference internal" href="#rl-signed-urls"><span class="std std-ref">Token Based Authentication</span></a>.</td>
</tr>
<tr class="row-odd"><td>Query String Handling</td>
<td><p class="first">How to treat query strings:</p>
@@ -590,7 +590,7 @@ must have an ssh key on the edge servers.</td>
</td>
</tr>
<tr class="row-odd"><td>Geo Limit Redirect URL</td>
-<td>(for HTTP routed delivery services only) This is the URL Traffic Router will redirect to when Geo Limit Failure. See <em class="xref std std-ref">geolimit-failure-redirect-feature</em></td>
+<td>(for HTTP routed delivery services only) This is the URL Traffic Router will redirect to when Geo Limit Failure. See <span class="xref std std-ref">geolimit-failure-redirect-feature</span></td>
</tr>
<tr class="row-even"><td>Bypass FQDN</td>
<td>(for HTTP routed delivery services only) This is the FQDN Traffic Router will redirect to (with the same path) when the max Bps or Max Tps for this deliveryservice are exceeded.</td>
@@ -621,7 +621,7 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
<td>The Origin Server’s base URL. This includes the protocol (http or https). Example: <code class="docutils literal"><span class="pre">http://movies.origin.com</span></code></td>
</tr>
<tr class="row-odd"><td>Use Multi Site Origin Feature</td>
-<td>Enable the Multi Site Origin feature for this delivery service. See <a class="reference internal" href="#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+<td>Enable the Multi Site Origin feature for this delivery service. See <a class="reference internal" href="#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
<tr class="row-even"><td>Multi Site Origin Algorithm</td>
<td><ul class="first last simple">
@@ -633,7 +633,7 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
</td>
</tr>
<tr class="row-odd"><td>CCR profile</td>
-<td>The Traffic Router profile for this delivery service. See <a class="reference internal" href="#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a>.</td>
+<td>The Traffic Router profile for this delivery service. See <a class="reference internal" href="#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a>.</td>
</tr>
<tr class="row-even"><td>Maximum Bits per Second allowed globally</td>
<td>The maximum bits per second this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used
@@ -650,10 +650,10 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
<td>Default Longitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this long.</td>
</tr>
<tr class="row-even"><td>Edge Header Rewrite Rules</td>
-<td>Header Rewrite rules to apply for this delivery service at the EDGE tier. See <a class="reference internal" href="#rl-header-rewrite"><em>Header Rewrite Options and DSCP</em></a>. <a class="footnote-reference" href="#id6" id="id1">[1]</a></td>
+<td>Header Rewrite rules to apply for this delivery service at the EDGE tier. See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id6" id="id1">[1]</a></td>
</tr>
<tr class="row-odd"><td>Mid Header Rewrite Rules</td>
-<td>Header Rewrite rules to apply for this delivery service at the MID tier. See <a class="reference internal" href="#rl-header-rewrite"><em>Header Rewrite Options and DSCP</em></a>. <a class="footnote-reference" href="#id6" id="id2">[1]</a></td>
+<td>Header Rewrite rules to apply for this delivery service at the MID tier. See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id6" id="id2">[1]</a></td>
</tr>
<tr class="row-even"><td>Regex Remap Expression</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier. See <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html">ATS documentation on regex_remap</a>. <a class="footnote-reference" href="#id6" id="id3">[1]</a></td>
@@ -689,16 +689,16 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
<td>(Read Only) The last time this delivery service was updated.</td>
</tr>
<tr class="row-odd"><td>Number of edges assigned</td>
-<td>(Read Only - change by clicking the <strong>Server Assignments</strong> button at the bottom) The number of EDGE caches assigned to this delivery service. See <a class="reference internal" href="#rl-assign-edges"><em>Server Assignments</em></a>.</td>
+<td>(Read Only - change by clicking the <strong>Server Assignments</strong> button at the bottom) The number of EDGE caches assigned to this delivery service. See <a class="reference internal" href="#rl-assign-edges"><span class="std std-ref">Server Assignments</span></a>.</td>
</tr>
<tr class="row-even"><td>Number of static DNS entries</td>
-<td>(Read Only - change by clicking the <strong>Static DNS</strong> button at the bottom) The number of static DNS entries for this delivery service. See <a class="reference internal" href="#rl-static-dns"><em>Static DNS Entries</em></a>.</td>
+<td>(Read Only - change by clicking the <strong>Static DNS</strong> button at the bottom) The number of static DNS entries for this delivery service. See <a class="reference internal" href="#rl-static-dns"><span class="std std-ref">Static DNS Entries</span></a>.</td>
</tr>
<tr class="row-odd"><td>Example delivery URL</td>
<td>(Read Only) An example of how the delivery URL may start. This could be multiple rows if multiple HOST_REGEXP entries have been entered.</td>
</tr>
<tr class="row-even"><td>Regular expressions for this delivery service</td>
-<td>A subtable of the regular expressions to use when routing traffic for this delivery service. See <a class="reference internal" href="#rl-ds-regexp"><em>Delivery Service Regexp</em></a>.</td>
+<td>A subtable of the regular expressions to use when routing traffic for this delivery service. See <a class="reference internal" href="#rl-ds-regexp"><span class="std std-ref">Delivery Service Regexp</span></a>.</td>
</tr>
</tbody>
</table>
@@ -1070,7 +1070,7 @@ http.parent_proxy.connect_attempts_timeout</td>
</tr>
</tbody>
</table>
-<p>see <a class="reference internal" href="quick_howto/multi_site.html#rl-multi-site-origin-qht"><em>Configure Multi Site Origin</em></a> for a <em>quick how to</em> on this feature.</p>
+<p>see <a class="reference internal" href="quick_howto/multi_site.html#rl-multi-site-origin-qht"><span class="std std-ref">Configure Multi Site Origin</span></a> for a <em>quick how to</em> on this feature.</p>
</div>
<div class="section" id="ccr-profile-or-traffic-router-profile">
<span id="rl-ccr-profile"></span><h3>CCR Profile or Traffic Router Profile<a class="headerlink" href="#ccr-profile-or-traffic-router-profile" title="Permalink to this headline">�</a></h3>
@@ -1310,30 +1310,30 @@ http.parent_proxy.connect_attempts_timeout</td>
<div class="section" id="the-coverage-zone-file-and-asn-table">
<span id="rl-asn-czf"></span><h3>The Coverage Zone File and ASN Table<a class="headerlink" href="#the-coverage-zone-file-and-asn-table" title="Permalink to this headline">�</a></h3>
<p>The Coverage Zone File (CZF) should contain a cachegroup name to network prefix mapping in the form:</p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "coverageZones": {
- "cache-group-01": {
- "network6": [
- "1234:5678::\/64",
- "1234:5679::\/64"
- ],
- "network": [
- "192.168.8.0\/24",
- "192.168.9.0\/24"
- ]
- }
- "cache-group-02": {
- "network6": [
- "1234:567a::\/64",
- "1234:567b::\/64"
- ],
- "network": [
- "192.168.4.0\/24",
- "192.168.5.0\/24"
- ]
- }
- }
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"coverageZones"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cache-group-01"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1234:5678::\/64"</span><span class="p">,</span>
+ <span class="s2">"1234:5679::\/64"</span>
+ <span class="p">],</span>
+ <span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"192.168.8.0\/24"</span><span class="p">,</span>
+ <span class="s2">"192.168.9.0\/24"</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="s2">"cache-group-02"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1234:567a::\/64"</span><span class="p">,</span>
+ <span class="s2">"1234:567b::\/64"</span>
+ <span class="p">],</span>
+ <span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"192.168.4.0\/24"</span><span class="p">,</span>
+ <span class="s2">"192.168.5.0\/24"</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
</pre></div>
</div>
<p>The CZF is an input to the Traffic Control CDN, and as such does not get generated by Traffic Ops, but rather, it gets consumed by Traffic Router. Some popular IP management systems output a very similar file to the CZF but in stead of a cachegroup an ASN will be listed. Traffic Ops has the “Networks (ASNs)” view to aid with the conversion of files like that to a Traffic Control CZF file; this table is not used anywhere in Traffic Ops, but can be used to script the conversion using the API.</p>
@@ -1345,7 +1345,7 @@ http.parent_proxy.connect_attempts_timeout</td>
<p>Parameters are shared between profiles if the set of <code class="docutils literal"><span class="pre">{</span> <span class="pre">name,</span> <span class="pre">config_file,</span> <span class="pre">value</span> <span class="pre">}</span></code> is the same. To change a value in one profile but not in others, the parameter has to be removed from the profile you want to change it in, and a new parameter entry has to be created (<strong>Add Parameter</strong> button at the bottom of the Parameters view), and assigned to that profile. It is easy to create new profiles from the <strong>Misc > Profiles</strong> view - just use the <strong>Add/Copy Profile</strong> button at the bottom of the profile view to copy an existing profile to a new one. Profiles can be exported from one system and imported to another using the profile view as well. It makes no sense for a parameter to not be assigned to a single profile - in that case it really has no function. To find parameters like that
use the <strong>Parameters > Orphaned Parameters</strong> view. It is easy to create orphaned parameters by removing all profiles, or not assigning a profile directly after creating the parameter.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
-<p class="last"><a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><em>Profile Parameters</em></a> in the <em>Configuring Traffic Ops</em> section.</p>
+<p class="last"><a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><span class="std std-ref">Profile Parameters</span></a> in the <em>Configuring Traffic Ops</em> section.</p>
</div>
</div>
<div class="section" id="tools">
@@ -1421,30 +1421,30 @@ http.parent_proxy.connect_attempts_timeout</td>
<p>What we currently do is have 2 scripts, one to do hard drive configuration and one to do network configuration. Both are relatively specific to the environment they were created in, and both are <em>probably</em> wrong for other organizations, however they are currently living in the “misc” directory as examples of how to do things.</p>
<p>We trigger those in a %pre section in ks.cfg and they will write config files to /tmp. We will then include those files in the appropriate places using %pre.</p>
<p>For example this is a section of our ks.cfg file:</p>
-<div class="highlight-python"><div class="highlight"><pre>%include /mnt/stage2/ks_scripts/packages.txt
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">packages</span><span class="o">.</span><span class="n">txt</span>
-%pre
- python /mnt/stage2/ks_scripts/create_network_line.py
- bash /mnt/stage2/ks_scripts/drive_config.sh
-%end
+<span class="o">%</span><span class="n">pre</span>
+ <span class="n">python</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">create_network_line</span><span class="o">.</span><span class="n">py</span>
+ <span class="n">bash</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">drive_config</span><span class="o">.</span><span class="n">sh</span>
+<span class="o">%</span><span class="n">end</span>
</pre></div>
</div>
<p>These two scripts will then run _before_ anaconda sets up it’s internal structures, then a bit further up in the ks.cfg file (outside of the %pre %end block) we do an</p>
-<div class="highlight-python"><div class="highlight"><pre>%include /mnt/stage2/ks_scripts/password.cfg
-...
-%include /tmp/network_line
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">password</span><span class="o">.</span><span class="n">cfg</span>
+<span class="o">...</span>
+<span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">network_line</span>
-%include /tmp/drive_config
-...
+<span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">drive_config</span>
+<span class="o">...</span>
</pre></div>
</div>
<p>This snarfs up the contents and inlines them.</p>
<p>If you only have one kind of hardware on your CDN it is probably best to just put the drive config right in the ks.cfg.</p>
<p>If you have simple networking needs (we use bonded interfaces in most, but not all locations and we have several types of hardware meaning different ethernet interface names at the OS level etc.) then something like this:</p>
-<div class="highlight-python"><div class="highlight"><pre>#!/bin/bash
-source /mnt/stage2/ks_scripts/network.cfg
-echo "network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR --netmask=$NETMASK --gateway=$GATEWAY --ipv6gateway=$GATEWAY --nameserver=$NAMESERVER --mtu=$MTU --hostname=$HOSTNAME" >> /tmp/network.cfg
-# Note that this is an example and may not work at all.
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span>
+<span class="n">source</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">network</span><span class="o">.</span><span class="n">cfg</span>
+<span class="n">echo</span> <span class="s2">"network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR --netmask=$NETMASK --gateway=$GATEWAY --ipv6gateway=$GATEWAY --nameserver=$NAMESERVER --mtu=$MTU --hostname=$HOSTNAME"</span> <span class="o">>></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">network</span><span class="o">.</span><span class="n">cfg</span>
+<span class="c1"># Note that this is an example and may not work at all.</span>
</pre></div>
</div>
<p>You could also put this in the %pre section. Lots of ways to solve it.</p>
@@ -1486,7 +1486,7 @@ echo "network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR -
</div>
<div class="section" id="snapshot-crconfig">
<span id="rl-snapshot-crconfig"></span><span id="index-12"></span><h4>Snapshot CRConfig<a class="headerlink" href="#snapshot-crconfig" title="Permalink to this headline">�</a></h4>
-<p>Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig, and Traffic Router polls Traffic Monitor for the same file. This is necessary to ensure that Traffic Monitor sees configuration changes first, which helps to ensure that the health and state of caches and delivery services propagates properly to Traffic Router. See <a class="reference internal" href="#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> for more information on the CRConfig file.</p>
+<p>Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig, and Traffic Router polls Traffic Monitor for the same file. This is necessary to ensure that Traffic Monitor sees configuration changes first, which helps to ensure that the health and state of caches and delivery services propagates properly to Traffic Router. See <a class="reference internal" href="#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> for more information on the CRConfig file.</p>
<p>To create a new snapshot, use the <em>Tools > Snapshot CRConfig</em> menu:</p>
<blockquote>
<div><ol class="arabic">
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/traffic_portal.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/traffic_portal.html b/docs/1.7.0/admin/traffic_portal.html
index 8cf934d..37f2249 100644
--- a/docs/1.7.0/admin/traffic_portal.html
+++ b/docs/1.7.0/admin/traffic_portal.html
@@ -106,7 +106,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Portal Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/traffic_router.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/traffic_router.html b/docs/1.7.0/admin/traffic_router.html
index 33adb51..dad7e42 100644
--- a/docs/1.7.0/admin/traffic_router.html
+++ b/docs/1.7.0/admin/traffic_router.html
@@ -108,7 +108,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Router Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li>
@@ -185,9 +185,25 @@
<div role="main" class="document">
<div class="section" id="traffic-router-administration">
-<h1>Traffic Router Administration<a class="headerlink" href="#traffic-router-administration" title="Permalink to this headline">�</a></h1>
+<h1><a class="toc-backref" href="#contents">Traffic Router Administration</a><a class="headerlink" href="#traffic-router-administration" title="Permalink to this headline">�</a></h1>
+<div class="contents topic" id="contents">
+<p class="topic-title first">Contents</p>
+<ul class="simple">
+<li><a class="reference internal" href="#traffic-router-administration" id="id4">Traffic Router Administration</a><ul>
+<li><a class="reference internal" href="#installing-traffic-router" id="id5">Installing Traffic Router</a></li>
+<li><a class="reference internal" href="#configuring-traffic-router" id="id6">Configuring Traffic Router</a></li>
+<li><a class="reference internal" href="#dnssec" id="id7">DNSSEC</a></li>
+<li><a class="reference internal" href="#troubleshooting-and-log-files" id="id8">Troubleshooting and log files</a></li>
+<li><a class="reference internal" href="#event-log-file-format" id="id9">Event Log File Format</a></li>
+<li><a class="reference internal" href="#geolimit-failure-redirect-feature" id="id10">GeoLimit Failure Redirect feature</a></li>
+<li><a class="reference internal" href="#steering-feature" id="id11">Steering feature</a></li>
+<li><a class="reference internal" href="#https-for-http-type-delivery-services" id="id12">HTTPS for Http Type Delivery Services</a></li>
+</ul>
+</li>
+</ul>
+</div>
<div class="section" id="installing-traffic-router">
-<h2>Installing Traffic Router<a class="headerlink" href="#installing-traffic-router" title="Permalink to this headline">�</a></h2>
+<h2><a class="toc-backref" href="#contents">Installing Traffic Router</a><a class="headerlink" href="#installing-traffic-router" title="Permalink to this headline">�</a></h2>
<p>The following are requirements to ensure an accurate set up:</p>
<ul class="simple">
<li>CentOS 6</li>
@@ -211,7 +227,7 @@
<li><p class="first">Install a traffic router: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">install</span> <span class="pre">traffic_router</span></code>.</p>
</li>
<li><dl class="first docutils">
-<dt>Edit <code class="docutils literal"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><em>Configuration files</em></a></dt>
+<dt>Edit <code class="docutils literal"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><span class="std std-ref">Configuration files</span></a></dt>
<dd><p class="first"># traffic_monitor.properties: url that should normally point to this file
traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.properties</p>
<p class="last"># Frequency for reloading this file
@@ -221,7 +237,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</li>
<li><p class="first">Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code>, and test lookups with dig and curl against that server.</p>
</li>
-<li><p class="first">Snapshot CRConfig; See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><em>Snapshot CRConfig</em></a></p>
+<li><p class="first">Snapshot CRConfig; See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><span class="std std-ref">Snapshot CRConfig</span></a></p>
</li>
</ol>
<div class="admonition note">
@@ -233,7 +249,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</ol>
</div>
<div class="section" id="configuring-traffic-router">
-<h2>Configuring Traffic Router<a class="headerlink" href="#configuring-traffic-router" title="Permalink to this headline">�</a></h2>
+<h2><a class="toc-backref" href="#contents">Configuring Traffic Router</a><a class="headerlink" href="#configuring-traffic-router" title="Permalink to this headline">�</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Starting with Traffic Router 1.5, many of the configuration files under <code class="docutils literal"><span class="pre">/opt/traffic_router/conf</span></code> are only needed to override the default configuration values for Traffic Router. Most of the given default values will work well for any CDN. Critical values that must be changed are hostnames and credentials for communicating with other Traffic Control components such as Traffic Ops and Traffic Monitor.</p>
@@ -242,7 +258,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
<p class="first admonition-title">Note</p>
<p class="last">Pre-existing installations having configuration files in <code class="docutils literal"><span class="pre">/opt/traffic_router/conf</span></code> will still be used and honored for Traffic Router 1.5 and onward.</p>
</div>
-<p>For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><em>Snapshot CRConfig</em></a> for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> for parameters that influence the behavior of Traffic Router via the CRConfig.</p>
+<p>For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><span class="std std-ref">Snapshot CRConfig</span></a> for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> for parameters that influence the behavior of Traffic Router via the CRConfig.</p>
<div class="section" id="configuration-files">
<span id="rl-tr-config-files"></span><h3>Configuration files<a class="headerlink" href="#configuration-files" title="Permalink to this headline">�</a></h3>
<table border="1" class="docutils">
@@ -359,7 +375,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</div>
</div>
<div class="section" id="dnssec">
-<span id="rl-tr-dnssec"></span><h2>DNSSEC<a class="headerlink" href="#dnssec" title="Permalink to this headline">�</a></h2>
+<span id="rl-tr-dnssec"></span><h2><a class="toc-backref" href="#contents">DNSSEC</a><a class="headerlink" href="#dnssec" title="Permalink to this headline">�</a></h2>
<div class="section" id="overview">
<h3>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">�</a></h3>
<p>Domain Name System Security Extensions (DNSSEC) is a set of extensions to DNS that provides a cryptographic mechanism for resolvers to verify the authenticity of responses served by an authoritative DNS server.</p>
@@ -368,7 +384,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</div>
<div class="section" id="operation">
<h3>Operation<a class="headerlink" href="#operation" title="Permalink to this headline">�</a></h3>
-<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> documentation for more information.</p>
+<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> documentation for more information.</p>
<p>Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each delivery service’s zone (e.g.: mydeliveryservice.cdn.kabletown.net) for every valid key that exists, in addition to the CDN TLD’s zone. A DS record is generated from each zone’s KSK and is placed in the CDN TLD’s zone (e.g.: cdn.kabletown.net); the DS record for the CDN TLD must be placed in its parent zone, which is not managed by Traffic Control.</p>
<p>The DNSKEY to DS record relationship allows resolvers to validate signatures across zone delegation points; with Traffic Control, we control all delegation points below the CDN’s TLD, <strong>however, the DS record for the CDN TLD must be placed in the parent zone (e.g.: kabletown.net), which is not managed by Traffic Control</strong>. As such, the DS record (available in the Traffic Ops DNSSEC administration UI) must be placed in the parent zone prior to enabling DNSSEC, and prior to generating a new CDN KSK. Based on your deployment’s DNS configuration, this might be a manual process or it might be automated; either way, extreme care and diligence must be taken and knowledge of the management of the upstream zone is imperative for a successful DNSSEC deployment.</p>
</div>
@@ -378,11 +394,11 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</div>
</div>
<div class="section" id="troubleshooting-and-log-files">
-<h2>Troubleshooting and log files<a class="headerlink" href="#troubleshooting-and-log-files" title="Permalink to this headline">�</a></h2>
+<h2><a class="toc-backref" href="#contents">Troubleshooting and log files</a><a class="headerlink" href="#troubleshooting-and-log-files" title="Permalink to this headline">�</a></h2>
<p>Traffic Router log files are in <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log</span></code>, and Tomcat log files are in <code class="docutils literal"><span class="pre">/opt/tomcat/logs</span></code>. Application related logging is in <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log/traffic_router.log</span></code>, while access logs are written to <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log/access.log</span></code>.</p>
</div>
<div class="section" id="event-log-file-format">
-<h2>Event Log File Format<a class="headerlink" href="#event-log-file-format" title="Permalink to this headline">�</a></h2>
+<h2><a class="toc-backref" href="#contents">Event Log File Format</a><a class="headerlink" href="#event-log-file-format" title="Permalink to this headline">�</a></h2>
<div class="section" id="summary">
<h3>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">�</a></h3>
<p>All access events to Traffic Router are logged to the file <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log/access.log</span></code>
@@ -393,8 +409,8 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="sample-message">
<h3>Sample Message<a class="headerlink" href="#sample-message" title="Permalink to this headline">�</a></h3>
<p>Items within brackets below are detailed under the HTTP and DNS sections</p>
-<div class="highlight-python"><div class="highlight"><pre>144140678.000 qtype=DNS chi=192.168.10.11 ttms=789 [Fields Specific to the DNS request] rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the DNS result]
-144140678.000 qtype=HTTP chi=192.168.10.11 ttms=789 [Fields Specific to the HTTP request] rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the HTTP result]
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields
</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">result</span><span class="p">]</span>
+<span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">HTTP</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <sp
an class="n">the</span> <span class="n">HTTP</span> <span class="n">result</span><span class="p">]</span>
</pre></div>
</div>
<div class="admonition note">
@@ -533,7 +549,7 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="http-specifics">
<h3>HTTP Specifics<a class="headerlink" href="#http-specifics" title="Permalink to this headline">�</a></h3>
<p>Sample Message</p>
-<div class="highlight-python"><div class="highlight"><pre>1452197640.936 qtype=HTTP chi=69.241.53.218 url="http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" pssc=302 ttms=0 rurl="http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8" rh="Accept: */*" rh="myheader: asdasdasdasfasg"
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1452197640.936</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">69.241</span><span class="o">.</span><span class="mf">53.218</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-&
quot;</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">0</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"Accept: */*"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"myheader: asdasdasdasfasg"</span>
</pre></div>
</div>
<p><strong>Request Fields</strong></p>
@@ -593,7 +609,7 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="dns-specifics">
<h3>DNS Specifics<a class="headerlink" href="#dns-specifics" title="Permalink to this headline">�</a></h3>
<p>Sample Message</p>
-<div class="highlight-python"><div class="highlight"><pre>144140678.000 qtype=DNS chi=192.168.10.11 ttms=123 xn=65535 fqdn=www.example.com. type=A class=IN ttl=12345 rcode=NOERROR rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" ans="192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">123</span> <span class="n">xn</span><span class="o">=</span><span class="mi">65535</span> <span class="n">fqdn</span><span class="o">=</span><span class="n">www</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">.</span> <span class="nb">type</span><span class="o">=</span><span class="n">A</span> <span class="n">class</span><span class="o">=</span><span class="n">IN</span> <span class="n">ttl</span><span class="o">=</span><span class="mi">12345</span> <span class="n">rcode</span><span class="o">=</span><span class="n">NOERRO
R</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">ans</span><span class="o">=</span><span class="s2">"192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"</span>
</pre></div>
</div>
<p><strong>Request Fields</strong></p>
@@ -672,7 +688,7 @@ NXDOMAIN (the domain/name requested does not exist)</td>
</div>
</div>
<div class="section" id="geolimit-failure-redirect-feature">
-<span id="rl-tr-ngb"></span><h2>GeoLimit Failure Redirect feature<a class="headerlink" href="#geolimit-failure-redirect-feature" title="Permalink to this headline">�</a></h2>
+<span id="rl-tr-ngb"></span><h2><a class="toc-backref" href="#contents">GeoLimit Failure Redirect feature</a><a class="headerlink" href="#geolimit-failure-redirect-feature" title="Permalink to this headline">�</a></h2>
<div class="section" id="id1">
<h3>Overview<a class="headerlink" href="#id1" title="Permalink to this headline">�</a></h3>
<p>This feature is also called ‘National GeoBlock’ feature which is short for ‘NGB’ feature. In this section, the acronym ‘NGB’ will be used for this feature.</p>
@@ -693,7 +709,7 @@ NXDOMAIN (the domain/name requested does not exist)</td>
</div>
</div>
<div class="section" id="steering-feature">
-<span id="rl-tr-steering"></span><h2>Steering feature<a class="headerlink" href="#steering-feature" title="Permalink to this headline">�</a></h2>
+<span id="rl-tr-steering"></span><h2><a class="toc-backref" href="#contents">Steering feature</a><a class="headerlink" href="#steering-feature" title="Permalink to this headline">�</a></h2>
<div class="section" id="id2">
<h3>Overview<a class="headerlink" href="#id2" title="Permalink to this headline">�</a></h3>
<p>A Steering delivery service is a delivery service that is used to “steer” traffic to other delivery services. A Steering delivery service will have target delivery services configured for it with weights assigned to them. Traffic Router uses the weights to make a consistent hash ring which it then uses to make sure that requests are routed to a target based on the configured weights. This consistent hash ring is separate from the consistent hash ring used in cache selection.</p>
@@ -725,6 +741,109 @@ NXDOMAIN (the domain/name requested does not exist)</td>
<p>For more information see the <a class="reference external" href="quick_howto/steering.html">steering how-to guide</a>.</p>
</div>
</div>
+<div class="section" id="https-for-http-type-delivery-services">
+<h2><a class="toc-backref" href="#contents">HTTPS for Http Type Delivery Services</a><a class="headerlink" href="#https-for-http-type-delivery-services" title="Permalink to this headline">�</a></h2>
+<p>Starting with version 1.7 Traffic Router added the ability to allow https traffic between itself and clients on a per http type delivery service basis.</p>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">The establishing of an HTTPS connection is much more computationally demanding than an HTTP connection.
+Since each client will in turn get redirected to ATS, Traffic Router is most always creating a new HTTPS connection for all HTTPS traffic.
+It is likely to mean that an existing Traffic Router will have some decrease in performance depending on the amount of https traffic you want to support
+As noted for DNSSEC, you may need to plan to scale Traffic Router vertically and/or horizontally to handle the new load</p>
+</div>
+<p>The summary for setting up https is to:</p>
+<ol class="arabic simple">
+<li>Select one of ‘https’, ‘http and https’, or ‘http to https’ for the delivery service</li>
+<li>Generate private keys for the delivery service using a wildcard domain such as <code class="docutils literal"><span class="pre">*.my-delivery-service.my-cdn.example.com</span></code></li>
+<li>Obtain and import signed certificate chain</li>
+<li>Snapshot CR Config</li>
+</ol>
+<p>Clients may make HTTPS requests delivery services only after Traffic Router receives the certificate chain from Traffic Ops and the new CR Config.</p>
+<div class="section" id="protocol-options">
+<h3>Protocol Options<a class="headerlink" href="#protocol-options" title="Permalink to this headline">�</a></h3>
+<dl class="docutils">
+<dt><em>https only</em></dt>
+<dd>Traffic Router will only redirect (send a 302) to clients communicating with a secure connection, all other clients will receive a 503</dd>
+<dt><em>http and https</em></dt>
+<dd>Traffic Router will redirect both secure and non-secure clients</dd>
+<dt><em>http to https</em></dt>
+<dd>Traffic Router will redirect non-secure clients with a 302 and a location that is secure (i.e. starting with ‘https’ instead of ‘http’), secure clients will remain on https</dd>
+<dt><em>http</em></dt>
+<dd>Any secure client will get an SSL handshake error. Non-secure clients will experience the same behavior as prior to 1.7</dd>
+</dl>
+</div>
+<div class="section" id="certificate-retrieval">
+<h3>Certificate Retrieval<a class="headerlink" href="#certificate-retrieval" title="Permalink to this headline">�</a></h3>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">If you have https delivery services in your CDN, Traffic Router will not accept <strong>any</strong> connections until it is able to
+fetch certificates from Traffic Ops and load them into memory. Traffic Router does not persist certificates to the java keystore or anywhere else.</p>
+</div>
+<p>Traffic Router fetches certificates into memory:</p>
+<ul class="simple">
+<li>At startup time</li>
+<li>When it receives a new CR Config</li>
+<li>Once an hour from whenever the most recent of the last of the above occurred</li>
+</ul>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">To adjust the frequency when Traffic Router fetches certificates add the parameter ‘certificates.polling.interval’ to CR Config and
+setting it to the desired time in milliseconds.</p>
+</div>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Taking a snapshot of CR Config may be used at times to avoid waiting the entire polling cycle for a new set of certificates.</p>
+</div>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">If a snapshot of CR Config is made that involves a delivery service missing its certificates, Traffic Router will ignore <strong>ALL</strong> changes in that CR-Config
+until one of the following occurs:
+* It receives certificates for that delivery service
+* Another snapshot of CR Config is created and the delivery service without certificates is changed so it’s HTTP protocol is set to ‘http’</p>
+</div>
+</div>
+<div class="section" id="certificate-chain-ordering">
+<h3>Certificate Chain Ordering<a class="headerlink" href="#certificate-chain-ordering" title="Permalink to this headline">�</a></h3>
+<p>The ordering of certificates within the certificate bundle matters. It must be:</p>
+<ol class="arabic simple">
+<li>Primary Certificate (e.g. the one created for <code class="docutils literal"><span class="pre">*.my-delivery-service.my-cdn.example.com</span></code>)</li>
+<li>Intermediate Certificate(s)</li>
+<li>Root Certificate from CA (optional)</li>
+</ol>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p class="last">If something is wrong with the certificate chain (e.g. the order of the certificates is backwards or for the wrong domain) the
+client will get an SSL handshake. Inspection of /opt/tomcat/logs/catalina.out is likely to yield information to reveal this.</p>
+</div>
+<p>To see the ordering of certificates you may have to manually split up your certificate chain and use openssl on each individual certificate</p>
+</div>
+<div class="section" id="suggested-way-of-setting-up-an-https-delivery-service">
+<h3>Suggested Way of Setting up an HTTPS Delivery Service<a class="headerlink" href="#suggested-way-of-setting-up-an-https-delivery-service" title="Permalink to this headline">�</a></h3>
+<p>Do the following in Traffic Ops:</p>
+<ol class="arabic simple">
+<li>Select one of ‘https’, ‘http and https’, or ‘http to https’ for the protocol field of a delivery service and click ‘Save’.</li>
+<li>Click ‘Manage SSL Keys’.</li>
+<li>Click ‘Generate New Keys’.</li>
+<li>Copy the contents of the Certificate Signing Request field and save it locally.</li>
+<li>Click ‘Load Keys’.</li>
+<li>Select ‘http’ for the protocol field of the delivery service and click ‘Save’ (to avoid preventing other CR Config updates from being blocked by Traffic Router)</li>
+<li>Follow your standard procedure for obtaining your signed certificate chain from a CA.</li>
+<li>After receiving your certificate chain import it into Traffic Ops.</li>
+<li>Edit the delivery service.</li>
+<li>Restore your original choice for the protocol field and click save.</li>
+<li>Click ‘Manage SSL Keys’.</li>
+<li>Click ‘Paste Existing Keys’.</li>
+<li>Paste the certificate chain into the CRT field.</li>
+<li>Click ‘Load Keys’.</li>
+<li>Take a new snapshot of CR Config.</li>
+</ol>
+<p>Once this is done you should be able to test you are getting correctly redirected by Traffic Router using curl commands to https destinations on your delivery service.</p>
+<p>A new testing tool was created for load testing traffic router, it allows you to generate requests from your local box to multiple delivery services of a single cdn.
+You can control which cdn, delivery services, how many transactions per delivery service, and how many concurrent requests.
+During the test it will provide feedback about request latency and transactions per second.</p>
+<p>While it is running it is suggested that you monitor your Traffic Router nodes for memory and CPU utilization.</p>
+</div>
+</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/traffic_server.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/traffic_server.html b/docs/1.7.0/admin/traffic_server.html
index 328aa14..490abfe 100644
--- a/docs/1.7.0/admin/traffic_server.html
+++ b/docs/1.7.0/admin/traffic_server.html
@@ -110,7 +110,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Server Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a></li>
</ul>
@@ -202,7 +202,7 @@
<dl class="docutils">
<dt><strong>traffic_ops_ort.pl</strong></dt>
<dd><p class="first">The traffic_ops_ort.pl should be installed on all caches (by puppet or other non Traffic Ops means), usually in /opt/ort. It is used to do initial install of the config files when the cache is being deployed, and to keep the config files up to date when the cache is already in service. The usage message of the script is shown below:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ sudo ./traffic_ops_ort.pl syncds warn https://to.cdn.kabletown.net
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ sudo ./traffic_ops_ort.pl syncds warn https://to.cdn.kabletown.net
Thu May 26 15:52:11 UTC 2016
====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
Usage: ./traffic_ops_ort.pl <Mode> <Log_Level> <Traffic_Ops_URL> <Traffic_Ops_Login> [optional flags]
@@ -226,11 +226,11 @@ $
</pre></div>
</div>
<p>For initial configuration or when major changes (like a Profile change) need to be made, run the script in “badass mode”. All required rpm packages will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted. Example run below:</p>
-<div class="highlight-python"><div class="highlight"><pre>run here
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">run</span> <span class="n">here</span>
</pre></div>
</div>
<p>For “every day changes” such as adding deliveryservices or changing records.config parameters caches should run the script in “syncds” mode out of cron. Example crontab entry:</p>
-<div class="highlight-python"><div class="highlight"><pre>*/15 * * * * /opt/ort/traffic_ops_ort.pl syncds warn https://traffops.kabletown.net admin:password > /tmp/ort/syncds.log 2>&1
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span> <span class="n">syncds</span> <span class="n">warn</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">traffops</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="n">admin</span><span class="p">:</span><span class="n">password</span> <span class="o">></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">syncds</span><span class="o">.</span
><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
</pre></div>
</div>
<div class="last admonition note">
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/traffic_stats.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/traffic_stats.html b/docs/1.7.0/admin/traffic_stats.html
index 904edce..a70274a 100644
--- a/docs/1.7.0/admin/traffic_stats.html
+++ b/docs/1.7.0/admin/traffic_stats.html
@@ -109,7 +109,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Stats Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a></li>
@@ -186,7 +186,7 @@
<div class="section" id="traffic-stats-administration">
<h1>Traffic Stats Administration<a class="headerlink" href="#traffic-stats-administration" title="Permalink to this headline">�</a></h1>
-<p>Traffic Stats actually consists of three seperate components: Traffic Stats, InfluxDB, and Grafana. See below for information on installing and configuring each component as well as configuring the integration between the three and Traffic Ops.</p>
+<p>Traffic Stats consists of three seperate components: Traffic Stats, InfluxDB, and Grafana. See below for information on installing and configuring each component as well as configuring the integration between the three and Traffic Ops.</p>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">�</a></h2>
<p><strong>Installing Traffic Stats:</strong></p>
@@ -199,12 +199,12 @@
</div></blockquote>
<p><strong>Installing InfluxDB:</strong></p>
<blockquote>
-<div><p><strong>As of Traffic Stats 1.4.0, InfluxDb 0.9.6 or higher is required. For InfluxDb versions less than 0.9.6 use Traffic Stats 1.3.0</strong></p>
-<p>In order to store traffic stats data you will need to install InfluxDB. It is recommended InfluxDB be installed in a 3 server cluster; VMs are acceptable. The documentation for installing InfluxDB can be found on the InfluxDB <a class="reference external" href="https://docs.influxdata.com/influxdb/latest/introduction/installation/">website</a>.</p>
+<div><p><strong>As of Traffic Stats 1.8.0, InfluxDb 1.0.0 or higher is required. For InfluxDb versions less than 1.0.0 use Traffic Stats 1.7.x</strong></p>
+<p>In order to store traffic stats data you will need to install <a class="reference external" href="https://docs.influxdata.com/influxdb/latest/introduction/installation/">InfluxDB</a>. While not required, it is recommended to use some sort of high availability option like <a class="reference external" href="https://portal.influxdata.com/">Influx enterprise</a>, <a class="reference external" href="https://github.com/influxdata/influxdb-relay">Influxdb Relay</a>, or another <a class="reference external" href="https://www.influxdata.com/high-availability/">high availability option</a>.</p>
</div></blockquote>
<p><strong>Installing Grafana:</strong></p>
<blockquote>
-<div>Grafana is used to display Traffic Stats/InfluxDB data in Traffic Ops. Grafana is typically run on the same server as Traffic Stats but this is not a requirement. Grafana can be installed on any server that can access InfluxDB and be accessed by Traffic Ops. Documentation on installing Grafana can be found <a class="reference external" href="http://docs.grafana.org/installation/">here</a>.</div></blockquote>
+<div>Grafana is used to display Traffic Stats/InfluxDB data in Traffic Ops. Grafana is typically run on the same server as Traffic Stats but this is not a requirement. Grafana can be installed on any server that can access InfluxDB and can be accessed by Traffic Ops. Documentation on installing Grafana can be found on the <a class="reference external" href="http://docs.grafana.org/installation/">Grafana website</a>.</div></blockquote>
</div>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">�</a></h2>
@@ -219,26 +219,27 @@ The following values need to be configured:</p>
<li><em>toUrl:</em> The URL of the Traffic Ops server used by Traffic Stats</li>
<li><em>influxUser:</em> The user to use when connecting to InfluxDB (if configured on InfluxDB, else leave default)</li>
<li><em>influxPassword:</em> That password to use when connecting to InfluxDB (if configured, else leave blank)</li>
-<li><em>polling interval:</em> The interval at which Traffic Monitor is polled and stats are stored in InfluxDB</li>
+<li><em>pollingInterval:</em> The interval at which Traffic Monitor is polled and stats are stored in InfluxDB</li>
<li><em>statusToMon:</em> The status of Traffic Monitor to poll (poll ONLINE or OFFLINE traffic monitors)</li>
<li><em>seelogConfig:</em> The absolute path of the seelong config file</li>
<li><em>dailySummaryPollingInterval:</em> The interval, in seconds, at which Traffic Stats checks to see if daily stats need to be computed and stored.</li>
<li><em>cacheRetentionPolicy:</em> The default retention policy for cache stats</li>
<li><em>dsRetentionPolicy:</em> The default retention policy for deliveryservice stats</li>
<li><em>dailySummaryRetentionPolicy:</em> The retention policy to be used for the daily stats</li>
+<li><em>influxUrls:</em> An array of influxdb hosts for Traffic Stats to write stats to.</li>
</ul>
</div></blockquote>
</div></blockquote>
<p><strong>Configuring InfluxDB:</strong></p>
<blockquote>
-<div><p>It is HIGHLY recommended that InfluxDB be configured for clustering. Documentation on clustering configuration can be found on the clustering page of the <a class="reference external" href="https://docs.influxdata.com/influxdb/latest/clustering/">InfluxDB Website</a>.</p>
-<p>Once InfluxDB is installed and clustering is configured, Databases and Retention Policies need to be created. Traffic Stats writes to three different databases: cache_stats, deliveryservice_stats, and daily_stats. More information about the databases and what data is stored in each can be found on the <a class="reference external" href="../overview/traffic_stats.html">overview</a> page.</p>
-<p>To easily create databases, retention policies, and continuous queries, run create_ts_databases.go from the influxdb_tools directory. See the <a class="reference external" href="traffic_stats.html#influxdb-tools">InfluxDb Tools</a> section below for more information.</p>
+<div><p>As mentioned above, it is recommended that InfluxDb be running in some sort of high availability configuration. There are several ways to achieve high availabilty so it is best to consult the high availability options on the <a class="reference external" href="https://www.influxdata.com/high-availability/">InfuxDB website</a>.</p>
+<p>Once InfluxDB is installed and configured, databases and retention policies need to be created. Traffic Stats writes to three different databases: cache_stats, deliveryservice_stats, and daily_stats. More information about the databases and what data is stored in each can be found on the <a class="reference external" href="../overview/traffic_stats.html">overview</a> page.</p>
+<p>To easily create databases, retention policies, and continuous queries, run create_ts_databases from the /opt/traffic_stats/influxdb_tools directory on your Traffic Stats server. See the <a class="reference external" href="traffic_stats.html#influxdb-tools">InfluxDb Tools</a> section below for more information.</p>
</div></blockquote>
<p><strong>Configuring Grafana:</strong></p>
<blockquote>
<div><blockquote>
-<div><p>In Traffic Ops the Health -> Graph View tab can be configured to display grafana graphs using influxDb data. In order for this to work correctly, you will need two things 1) a parameter added to traffic ops with the graph URL (we will discuss later) and 2) the graphs created in grafana. See below for how to create some simple graphs in grafana. These instructions assume that InfluxDB has been installed and conifugred and that data has been written to it. If this is not true, you will not see any graphs.</p>
+<div><p>In Traffic Ops the Health -> Graph View tab can be configured to display grafana graphs using influxDb data. In order for this to work correctly, you will need two things 1) a parameter added to traffic ops with the graph URL (more information below) and 2) the graphs created in grafana. See below for how to create some simple graphs in grafana. These instructions assume that InfluxDB has been configured and that data has been written to it. If this is not true, you will not see any graphs.</p>
<ul>
<li><p class="first">Login to grafana as an admin user <a class="reference external" href="http://grafana_url:3000/login">http://grafana_url:3000/login</a></p>
</li>
@@ -319,8 +320,8 @@ The following values need to be configured:</p>
</table>
</div></blockquote>
</div>
-<div class="section" id="id1">
-<h2>InfluxDb Tools<a class="headerlink" href="#id1" title="Permalink to this headline">�</a></h2>
+<div class="section" id="id2">
+<h2>InfluxDb Tools<a class="headerlink" href="#id2" title="Permalink to this headline">�</a></h2>
<p>Under the Traffic Stats source directory there is a directory called influxdb_tools. These tools are meant to be used as one-off scripts to help a user quickly get new databases and continuous queries setup in influxdb.
They are specific for traffic stats and are not meant to be generic to influxdb. Below is an brief description of each script along with how to use it.</p>
<dl class="docutils">
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/traffic_vault.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/traffic_vault.html b/docs/1.7.0/admin/traffic_vault.html
index 5ce808f..c86266b 100644
--- a/docs/1.7.0/admin/traffic_vault.html
+++ b/docs/1.7.0/admin/traffic_vault.html
@@ -111,7 +111,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Vault Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a></li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/basics/cache_revalidation.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/basics/cache_revalidation.html b/docs/1.7.0/basics/cache_revalidation.html
index 8f35527..84b7f54 100644
--- a/docs/1.7.0/basics/cache_revalidation.html
+++ b/docs/1.7.0/basics/cache_revalidation.html
@@ -83,7 +83,7 @@
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Cache Control Headers and Revalidation</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Cache Control Headers and Revalidation</a></li>
</ul>
</li>
</ul>
@@ -187,49 +187,49 @@
<div class="section" id="cache-control-headers-and-revalidation">
<span id="index-0"></span><h1>Cache Control Headers and Revalidation<a class="headerlink" href="#cache-control-headers-and-revalidation" title="Permalink to this headline">�</a></h1>
<p>The <a class="reference external" href="https://www.ietf.org/rfc/rfc2616.txt">HTTP/1.1 spec</a> allows for origin servers and clients to influence how caches treat their requests and responses. By default, the Traffic Control CDN will honor cache control headers. Most commonly, origin servers will tell the downstream caches how long a response can be cached:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Cache-Control: max-age=86400
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">86400</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
<p>In the above response, the origin server tells downstream caching systems that the maximum time to cache this response for is 86400 seconds. The origin can also add a <code class="docutils literal"><span class="pre">Expires:</span></code> header, explicitly telling the cache the time this response is to be expired. When a response is expired it usually doesn’t get deleted from the cache, but, when a request comes in that would have hit on this response if it was not expired, the cache <em>revalidates</em> the response. In stead of requesting the object again from the origin server, the cache will send a request to the origin indicating what version of the response it has, and asking if it has changed. If it changed, the server will send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> response, with the new data. If it has not changed, the origin server will send back a <code class="docutils literal"><span class="pre">304</spa
n> <span class="pre">Not</span> <span class="pre">Modified</span></code> response indicating the response is still valid, and that the cache can reset the timer on the response expiration. To indicate what version the client (cache) has it will add an <code class="docutils literal"><span class="pre">If-Not-Modified-Since:</span></code> header, or an <code class="docutils literal"><span class="pre">If-None-Match:</span></code> header. For example, in the <code class="docutils literal"><span class="pre">If-None-Match:</span></code> case, the origin will send and <code class="docutils literal"><span class="pre">ETag</span></code> header that uniquely identifies the response. The client can use that in an revalidation request like:</p>
-<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
-If-None-Match: "1aa008f-2d-50a3559482cc0"
-Host: www.origin.com
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">If</span><span class="o">-</span><span class="kc">None</span><span class="o">-</span><span class="n">Match</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
<p>If the content has changed (meaning, the new response would not have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code>, like:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 18 Dec 2014 3:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50aa00feadd"
-Cache-Control: max-age=604800
-Content-Length: 49
-Connection: close
-Content-Type: text/html; charset=UTF-8
-
-<html><body>This is NOT a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50aa00feadd"</span>
+<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">604800</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">49</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">NOT</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
<p>If the Content did not change (meaning, the response would have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code>, like:</p>
-<div class="highlight-python"><div class="highlight"><pre>304 Not Modified
-Date: Sun, 18 Dec 2014 3:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Cache-Control: max-age=604800
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">304</span> <span class="n">Not</span> <span class="n">Modified</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">604800</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
</pre></div>
</div>
<p>Note that the 304 response only has headers, not the data.</p>
[12/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/hwinfo.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/hwinfo.html b/docs/latest/development/traffic_ops_api/v11/hwinfo.html
index 06e5c56..b6d2887 100644
--- a/docs/latest/development/traffic_ops_api/v11/hwinfo.html
+++ b/docs/latest/development/traffic_ops_api/v11/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/v11/parameter.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/parameter.html b/docs/latest/development/traffic_ops_api/v11/parameter.html
index 75ce97d..4c91d81 100644
--- a/docs/latest/development/traffic_ops_api/v11/parameter.html
+++ b/docs/latest/development/traffic_ops_api/v11/parameter.html
@@ -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="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">"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="mi">0</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="mi">0</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>
@@ -323,28 +323,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="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">"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="mi">0</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="mi">0</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>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/phys_location.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/phys_location.html b/docs/latest/development/traffic_ops_api/v11/phys_location.html
index 66a6264..fa0d8ff 100644
--- a/docs/latest/development/traffic_ops_api/v11/phys_location.html
+++ b/docs/latest/development/traffic_ops_api/v11/phys_location.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-phys-loc"></span><h1>Physical Location<a class="headerlink" href="#physical-location" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-phys-locations">
<span id="to-api-v11-phys-loc-route"></span><h2>/api/1.1/phys_locations<a class="headerlink" href="#api-1-1-phys-locations" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/phys_locations.json</strong></p>
+<p><strong>GET /api/1.1/phys_locations</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,47 +208,47 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</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>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<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">email</span></code></td>
+<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">city</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</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>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -256,40 +256,52 @@
<td>string</td>
<td> </td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
</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">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
- <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"region"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"poc"</span><span class="p">:</span> <span class="s">"John Doe"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(321) 555-1111"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"IL"</span><span class="p">,</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"john.doe@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"60636"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 4th Street"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"chicago"</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -322,19 +334,549 @@
</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">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Ashburn"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Ashburn"</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.1/phys_locations/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Physical location ID.</td>
+</tr>
+</tbody>
+</table>
+<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">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</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">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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>
+<dl class="docutils">
+<dt><strong>PUT /api/1.1/phys_locations/:id</strong></dt>
+<dd><p class="first">Update a physical location</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>Physical location id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</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">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">address</span></code></td>
+<td>yes</td>
+<td>Physical location address.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td>Physical location city.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td>Physical location comments.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>no</td>
+<td>Physical location email.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>Physical location name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td>Physical location phone.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Physical location point of contact.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>no</td>
+<td>Physical location region ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>Physical location short name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td>Physical location state.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td>Physical location zip.</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">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</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">"Physical location 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="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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.1/regions/:region_name/phys_locations</strong></dt>
+<dd><p class="first">Create physical location.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p>region_name: the name of the region to create physical location into.</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="16%" />
+<col width="56%" />
+</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">region_name</span></code></td>
+<td>yes</td>
+<td>The name of the physical location</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</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 location</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>The short name of the location</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Point of contact</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td> </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">"my physical location1"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span>
+ <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"this is physical location1"</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="22%" />
+<col width="11%" />
+<col width="67%" />
+</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>The id of the physical location created.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the location</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>The short name of the location</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionName</span></code></td>
+<td>string</td>
+<td>The region name the physical location belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td>Point of contact</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</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">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span>
+ <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span>
+ <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span>
+ <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span>
+ <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span>
+ <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span>
+ <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span>
+ <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/profile.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/profile.html b/docs/latest/development/traffic_ops_api/v11/profile.html
index bac5795..929aad7 100644
--- a/docs/latest/development/traffic_ops_api/v11/profile.html
+++ b/docs/latest/development/traffic_ops_api/v11/profile.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-profile"></span><h1>Profiles<a class="headerlink" href="#profiles" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-profiles">
<span id="to-api-v11-profiles-route"></span><h2>/api/1.1/profiles<a class="headerlink" href="#api-1-1-profiles" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/profiles.json</strong></p>
+<p><strong>GET /api/1.1/profiles</strong></p>
<blockquote>
<div><blockquote>
<div><p>Authentication Required: Yes</p>
@@ -229,13 +229,13 @@
</table>
</div></blockquote>
<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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -245,7 +245,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/profiles/trimmed.json</strong></p>
+<p><strong>GET /api/1.1/profiles/trimmed</strong></p>
<blockquote>
<div><blockquote>
<div><p>Authentication Required: Yes</p>
@@ -272,10 +272,85 @@
</table>
</div></blockquote>
<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">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</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.1/profiles/:id</strong></p>
+<blockquote>
+<div><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="22%" />
+<col width="16%" />
+<col width="62%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>The ID of the profile.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="10%" />
+<col width="68%" />
+</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">lastUpdated</span></code></td>
+<td>array</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">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<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">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</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/v11/region.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/region.html b/docs/latest/development/traffic_ops_api/v11/region.html
index bcb14dd..a78468c 100644
--- a/docs/latest/development/traffic_ops_api/v11/region.html
+++ b/docs/latest/development/traffic_ops_api/v11/region.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-region"></span><h1>Regions<a class="headerlink" href="#regions" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-regions">
<span id="to-api-v11-regions-route"></span><h2>/api/1.1/regions<a class="headerlink" href="#api-1-1-regions" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/regions.json</strong></p>
+<p><strong>GET /api/1.1/regions</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,32 +208,339 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td> </td>
+<td>Region ID.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
-<td> </td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</td>
</tr>
</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">"name"</span><span class="p">:</span> <span class="s">"Atlanta"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"6"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Beltway"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"7"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/regions/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Region id.</td>
+</tr>
+</tbody>
+</table>
+<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>Region ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</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">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
+<dl class="docutils">
+<dt><strong>PUT /api/1.1/regions/:id</strong></dt>
+<dd><p class="first">Update a region</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>Region id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="31%" />
+<col width="19%" />
+<col width="50%" />
+</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 region</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>yes</td>
+<td>The division Id</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">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</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">division</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</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> </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">"Region 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">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</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.1/divisions/:division_name/regions</strong></dt>
+<dd><p class="first">Create Region</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p>division_name - The name of division to create new region into.</p>
+<p>** Request Route Parameters**</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">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">division_name</span></code></td>
+<td>yes</td>
+<td>The name of division will create new region in</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="14%" />
+<col width="59%" />
+</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 region</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">"myregion1"</span><span class="p">,</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="27%" />
+<col width="11%" />
+<col width="61%" />
+</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>name of region created</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>id of region created</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>the division name the region belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionId</span></code></td>
+<td>string</td>
+<td>the id of division the region belongs to.</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="s1">'divisionName'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span>
+ <span class="s1">'divsionId'</span><span class="p">:</span> <span class="s1">'4'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'19'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/role.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/role.html b/docs/latest/development/traffic_ops_api/v11/role.html
index 524b240..0c3cab6 100644
--- a/docs/latest/development/traffic_ops_api/v11/role.html
+++ b/docs/latest/development/traffic_ops_api/v11/role.html
@@ -227,13 +227,13 @@
</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">"name"</span><span class="p">:</span> <span class="s">"read-only"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"privLevel"</span><span class="p">:</span> <span class="s">"10"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"read-only user"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"read-only"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"privLevel"</span><span class="p">:</span> <span class="s2">"10"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"read-only user"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
[30/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/profile_parameter.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/profile_parameter.html b/docs/1.7.0/development/traffic_ops_api/v12/profile_parameter.html
new file mode 100644
index 0000000..d22618c
--- /dev/null
+++ b/docs/1.7.0/development/traffic_ops_api/v12/profile_parameter.html
@@ -0,0 +1,887 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Profile parameters — Traffic Control 1.7 documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <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="InfluxDB" href="influxdb.html"/>
+ <link rel="prev" title="Profiles" href="profile.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../../_static/tc_logo.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../../index.html">Traffic Control 1.7</a> »</li>
+
+ <li><a href="../../index.html">Developer’s Guide</a> »</li>
+
+ <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li>
+
+ <li>Profile parameters</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../../_sources/development/traffic_ops_api/v12/profile_parameter.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">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>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="profile-parameters">
+<span id="to-api-v12-profileparameters"></span><h1>Profile parameters<a class="headerlink" href="#profile-parameters" title="Permalink to this headline">�</a></h1>
+<div class="section" id="api-1-2-profileparameters">
+<span id="to-api-v12-profileparameters-route"></span><h2>/api/1.2/profileparameters<a class="headerlink" href="#api-1-2-profileparameters" title="Permalink to this headline">�</a></h2>
+<p><strong>POST /api/1.2/profileparameters</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Associate parameter to profile.</p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Properties</strong>
+This accept two formats: single profile-parameter, profile-parameter array.</p>
+<p>Single profile-parameter format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="65%" />
+</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">profileId</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parameterId</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+<p>Profile-parameter array format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="65%" />
+</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> </td>
+<td>yes</td>
+<td>profile-parameter array.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>profileId</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>parameterId</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span>Single profile-parameter format:
+
+{
+ "profileId": 2,
+ "parameterId": 6
+}
+
+Profile-parameter array format:
+
+[
+ {
+ "profileId": 2,
+ "parameterId": 6
+ },
+ {
+ "profileId": 2,
+ "parameterId": 7
+ },
+ {
+ "profileId": 3,
+ "parameterId": 6
+ }
+]
+
+ **Response Properties**
+
+ +-------------------+---------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+=========+=====================================================+
+ | ``response`` | array | Profile-parameter associations. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>profileId`` | string | Profile id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>parameterId`` | string | Parameter id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+---------+-----------------------------------------------------+
+</pre></div>
+</div>
+<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="s2">"profileId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"7"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="s2">"alerts"</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">"Profile parameter associations were created."</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>DELETE /api/1.2/profileparameters/{:profile_id}/{:parameter_id}</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Delete a profile parameter association.</p>
+<blockquote>
+<div><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="23%" />
+<col width="13%" />
+<col width="65%" />
+</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">profile_id</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parameter_id</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="10%" />
+<col width="66%" />
+</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>
+</div></blockquote>
+</div></blockquote>
+<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="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">"Profile parameter association was deleted."</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>POST /api/1.2/profiles/name/{:name}/parameters</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+If the profile does not exist, the API returns fail.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper. If there is parameter’s secure equals 1 in the request properties, need admin role.</p>
+<blockquote>
+<div><p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="14%" />
+<col width="70%" />
+</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>
+</div></blockquote>
+<p><strong>Request Properties</strong>
+The request properties 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="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><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>array parameters 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>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">single</span> <span class="n">parameter</span> <span class="nb">format</span> <span class="n">exampe</span><span class="p">:</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="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="p">}</span>
+
+<span class="mf">2.</span> <span class="n">array</span> <span class="nb">format</span> <span class="n">example</span><span class="p">:</span>
+<span class="p">[</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="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="p">},</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">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</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="p">}</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span>+------------------+---------+--------------------------------------------------------------------------------------+
+| Name | Type | Description |
++==================+=========+======================================================================================+
+| ``response`` | | Parameters associated with the profile. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileName`` | string | profile name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileId`` | integer | profile index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>parameters`` | array | parameters array |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>id`` | integer | parameter index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>name`` | string | parameter name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>configFile`` | string | parameter config_file |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>value`` | string | parameter value |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``alerts`` | array | A collection of alert messages. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>level`` | string | success, info, warning or error. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>text`` | string | Alert message. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``version`` | string | |
++------------------+---------+--------------------------------------------------------------------------------------+
+</pre></div>
+</div>
+<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="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span> <span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:[</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>
+ <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">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</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="s2">"1"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="s2">"alerts"</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">""</span><span class="n">Assign</span> <span class="n">parameters</span> <span class="n">successfully</span> <span class="n">to</span> <span class="n">profile</span> <span class="n">CCR1</span><span class="s2">"</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>POST /api/1.2/profiles/id/{:id}/parameters</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+If the profile does not exist, the API returns fail.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper. If there is parameter’s secure equals 1 in the request properties, need admin role.</p>
+<blockquote>
+<div><p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="14%" />
+<col width="70%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>profile name.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Request Properties</strong>
+The request properties 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="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><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>array parameters 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>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">single</span> <span class="n">parameter</span> <span class="nb">format</span> <span class="n">exampe</span><span class="p">:</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="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="p">}</span>
+
+<span class="mf">2.</span> <span class="n">array</span> <span class="nb">format</span> <span class="n">example</span><span class="p">:</span>
+<span class="p">[</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="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="p">},</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">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</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="p">}</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span>+------------------+---------+--------------------------------------------------------------------------------------+
+| Name | Type | Description |
++==================+=========+======================================================================================+
+| ``response`` | | Parameters associated with the profile. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileName`` | string | profile name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileId`` | integer | profile index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>parameters`` | array | parameters array |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>id`` | integer | parameter index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>name`` | string | parameter name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>configFile`` | string | parameter config_file |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>value`` | string | parameter value |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``alerts`` | array | A collection of alert messages. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>level`` | string | success, info, warning or error. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>text`` | string | Alert message. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``version`` | string | |
++------------------+---------+--------------------------------------------------------------------------------------+
+</pre></div>
+</div>
+<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="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span> <span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:[</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>
+ <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">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</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="s2">"1"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="s2">"alerts"</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">""</span><span class="n">Assign</span> <span class="n">parameters</span> <span class="n">successfully</span> <span class="n">to</span> <span class="n">profile</span> <span class="n">CCR1</span><span class="s2">"</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>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">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>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../../',
+ VERSION:'1.7',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/region.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/region.html b/docs/1.7.0/development/traffic_ops_api/v12/region.html
index cb41278..b3b1570 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/region.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/region.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="Roles" href="role.html"/>
- <link rel="prev" title="Divisions" href="division.html"/>
+ <link rel="prev" title="InfluxDB" href="influxdb.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -180,7 +180,7 @@
<a href="role.html" class="btn btn-neutral float-right" title="Roles">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="division.html" class="btn btn-neutral" title="Divisions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="influxdb.html" class="btn btn-neutral" title="InfluxDB"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -190,7 +190,7 @@
<span id="to-api-v12-region"></span><h1>Regions<a class="headerlink" href="#regions" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-regions">
<span id="to-api-v12-regions-route"></span><h2>/api/1.2/regions<a class="headerlink" href="#api-1-2-regions" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/regions.json</strong></p>
+<p><strong>GET /api/1.1/regions</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,28 +208,227 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td> </td>
+<td>Region ID.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
-<td> </td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</td>
</tr>
</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">"name"</span><span class="p">:</span> <span class="s">"Atlanta"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"6"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Beltway"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"7"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/regions/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Region id.</td>
+</tr>
+</tbody>
+</table>
+<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>Region ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</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">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<dl class="docutils">
+<dt><strong>PUT /api/1.2/regions/:id</strong></dt>
+<dd><p class="first">Update a region</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>Region id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="31%" />
+<col width="19%" />
+<col width="50%" />
+</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 region</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>yes</td>
+<td>The division Id</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">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</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">division</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</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> </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">"Region 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">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+ <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -284,8 +483,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">"myregion1"</span><span class="p">,</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">"myregion1"</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -328,12 +527,12 @@
</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">'divisionName'</span><span class="p">:</span> <span class="s">'mydivision1'</span><span class="p">,</span>
- <span class="s">'divsionId'</span><span class="p">:</span> <span class="s">'4'</span><span class="p">,</span>
- <span class="s">'name'</span><span class="p">:</span> <span class="s">'myregion1'</span><span class="p">,</span>
- <span class="s">'id'</span><span class="p">:</span> <span class="s">'19'</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">'divisionName'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span>
+ <span class="s1">'divsionId'</span><span class="p">:</span> <span class="s1">'4'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'19'</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -354,7 +553,7 @@
<a href="role.html" class="btn btn-neutral float-right" title="Roles">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="division.html" class="btn btn-neutral" title="Divisions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="influxdb.html" class="btn btn-neutral" title="InfluxDB"><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/1.7.0/development/traffic_ops_api/v12/role.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/role.html b/docs/1.7.0/development/traffic_ops_api/v12/role.html
index ac350ee..8cfd265 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/role.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/role.html
@@ -227,13 +227,13 @@
</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">"name"</span><span class="p">:</span> <span class="s">"read-only"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"privLevel"</span><span class="p">:</span> <span class="s">"10"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"read-only user"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"read-only"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"privLevel"</span><span class="p">:</span> <span class="s2">"10"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"read-only user"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
[21/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
index 5ca4bb3..a6a6b66 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
@@ -35,174 +35,224 @@ Delivery Service
**Response Properties**
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description | |
- +==========================+========+======================================================================================================================================+=====================================================================================================+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``active`` | bool | true if active, false if inactive. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE | |
- | | | - 1: serve with https:// at EDGE | |
- | | | - 2: serve with both http:// and https:// at EDGE | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | string | - 0: None - no limitations | |
- | | | - 1: Only route on CZF file hit | |
- | | | - 2: Only route on CZF hit or when from USA | |
- | | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents | |
- | | | routing to the content by Traffic Router. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectURL`` | string | This is the URL Traffic Router will redirect to when Geo Limit Failure. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the | |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded | |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for | |
- | | | HTTP deliveryservices | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``headerRewrite`` | string | The EDGE header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``id`` | string | The deliveryservice id (database row number). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field 1. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 2. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``matchList`` | array | Array of matchList hashes. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v12-types use_in_table='regex'). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all | |
- | | | available). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | string | | Is the Multi Site Origin feature enabled for this delivery service. See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the | |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. | |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. | |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. | |
- | | | - true: token based auth is enabled for this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: | |
- | | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) | |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. | |
- | | | - 2 Use the cache_range_requests plugin. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "geoLimitRedirectURL": "",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
- },
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
{ .. },
{ .. }
- ],
+ ]
}
|
-**GET /api/1.2/deliveryservices/:id.json**
+
+**GET /api/1.2/deliveryservices/:id**
Retrieves a specific delivery service. See also `Using Traffic Ops - Delivery Service <http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
@@ -215,20 +265,20 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+========+======================================================================================================================================+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``active`` | bool | true if active, false if inactive. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -241,6 +291,10 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimit`` | string | - 0: None - no limitations |
| | | - 1: Only route on CZF file hit |
| | | - 2: Only route on CZF hit or when from USA |
@@ -248,7 +302,9 @@ Delivery Service
| | | Note that this does not prevent access to content or makes content secure; it just prevents |
| | | routing to the content by Traffic Router. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectURL`` | string | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
| | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
@@ -257,8 +313,6 @@ Delivery Service
| | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
| | | HTTP deliveryservices |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``headerRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -266,8 +320,14 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc`` | string | Description field 1. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc1`` | string | Description field 2. |
@@ -276,7 +336,7 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``matchList`` | array | Array of matchList hashes. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v12-types use_in_table='regex'). |
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``>>setNumber`` | string | The set Number of the matchList. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -285,39 +345,61 @@ Delivery Service
| ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
| | | available). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
| | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
| | | - 2: drop query string at edge, and do not use it in the cache-key. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``remapText`` | string | Additional raw remap line text. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
| | | - true: token based auth is enabled for this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
+ | ``trResponseHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | string | Entry points in to the CDN for this deliveryservice. |
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -325,54 +407,76 @@ Delivery Service
{
"response": [
{
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "geoLimitRedirectURL":"",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
}
- ],
+ ]
}
+|
+
+
.. _to-api-v12-ds-health:
Health
@@ -395,7 +499,11 @@ Health
+------------------+---------+-------------------------------------------------+
| ``>locations`` | array | |
+------------------+---------+-------------------------------------------------+
- | ``>destination`` | string | |
+ | ``>destination`` | hash |
<TRUNCATED>
[07/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
index 1062d1e..0b6cf22 100644
--- a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
+++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
@@ -198,82 +198,76 @@
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="10%" />
-<col width="3%" />
-<col width="50%" />
-<col width="38%" />
+<col width="15%" />
+<col width="5%" />
+<col width="80%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
-<th class="head"> </th>
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
-<td>string</td>
-<td>Unique string that describes this deliveryservice.</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">active</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
<td>bool</td>
<td>true if active, false if inactive.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
<td>string</td>
<td>Cache URL rule to apply to this delivery service.</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
-<td>string</td>
-<td><ul class="first last simple">
-<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
-<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
-<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
-</ul>
-</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
-<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
<td>string</td>
<td>The path portion of the URL to check this deliveryservice for health.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS bypass response.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
<td>string</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
<td>string</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
@@ -283,128 +277,137 @@ globalMaxMbps traffic on this deliveryservice.</td>
<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
routing to the content by Traffic Router.</p>
</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectURL</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
<td>string</td>
-<td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td>
<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
<td>string</td>
<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">headerRewrite</span></code></td>
-<td>string</td>
-<td>The EDGE header rewrite actions to perform.</td>
-<td> </td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
<td>string</td>
<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The deliveryservice id (database row number).</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
<td>string</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
<td>bool</td>
<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
<td>Description field 2.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
<td>string</td>
<td>Description field 2.</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
<td>array</td>
<td>Array of matchList hashes.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
-<td>The type of MatchList (one of :ref:to-api-v12-types use_in_table=’regex’).</td>
-<td> </td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
<td>string</td>
<td>The set Number of the matchList.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
<td>string</td>
<td>The regexp for the matchList.</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
<td>string</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
<td>string</td>
-<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
-<td> </td>
+<td>The MID header rewrite actions to perform.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
<td>string</td>
-<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
-<td> </td>
+<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
<td>string</td>
-<td>The MID header rewrite actions to perform.</td>
-<td> </td>
+<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
-<td>string</td>
-<td> </td>
-<td>Is the Multi Site Origin feature enabled for this delivery service. See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
<td>The origin server base URL (FQDN when used in this instance, includes the
protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
+<td>string</td>
<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
<td>string</td>
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
<td>string</td>
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
-<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
<td>string</td>
@@ -414,17 +417,28 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<li>2: drop query string at edge, and do not use it in the cache-key.</li>
</ul>
</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
<td>string</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
-<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
<td>string</td>
<td>Additional raw remap line text.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
<td>bool</td>
@@ -433,91 +447,112 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<li>true: token based auth is enabled for this deliveryservice.</li>
</ul>
</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
<td>string</td>
-<td><p class="first">How to treat range requests:</p>
-<ul class="last simple">
-<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
-<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
-<li>2 Use the cache_range_requests plugin.</li>
-</ul>
-</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
-<td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
-<td>array</td>
-<td>Entry points into the CDN for this deliveryservice.</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
<td> </td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "geoLimitRedirectURL": "",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
- },
- { .. },
- { .. }
- ],
-}
+<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">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="o">..</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/deliveryservices/:id.json</strong></p>
+<p><strong>GET /api/1.2/deliveryservices/:id</strong></p>
<blockquote>
<div><p>Retrieves a specific delivery service. See also <a class="reference external" href="http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
@@ -536,58 +571,65 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
-<td>string</td>
-<td>Unique string that describes this deliveryservice.</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">active</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
<td>bool</td>
<td>true if active, false if inactive.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
<td>string</td>
<td>Cache URL rule to apply to this delivery service.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
-<td>string</td>
-<td><ul class="first last simple">
-<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
-<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
-<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
-</ul>
-</td>
-</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
<td>string</td>
<td>The path portion of the URL to check this deliveryservice for health.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS bypass response.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
<td>string</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
<td>string</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
@@ -598,9 +640,13 @@ globalMaxMbps traffic on this deliveryservice.</td>
routing to the content by Traffic Router.</p>
</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectURL</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
<td>string</td>
-<td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
+<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
@@ -613,27 +659,35 @@ dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliver
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">headerRewrite</span></code></td>
-<td>string</td>
-<td>The EDGE header rewrite actions to perform.</td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
<td>string</td>
<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The deliveryservice id (database row number).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
<td>string</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
<td>bool</td>
<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
@@ -652,7 +706,7 @@ globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
-<td>The type of MatchList (one of :ref:to-api-v12-types use_in_table=’regex’).</td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
<td>string</td>
@@ -667,32 +721,57 @@ globalMaxMbps traffic on this deliveryservice.</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
<td>string</td>
<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
<td>string</td>
<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
-<td>string</td>
-<td>The MID header rewrite actions to perform.</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
<td>The origin server base URL (FQDN when used in this instance, includes the
protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
<td>string</td>
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
<td>string</td>
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
<td>string</td>
<td><ul class="first last simple">
<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
@@ -701,15 +780,29 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</ul>
</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
<td>string</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
<td>string</td>
<td>Additional raw remap line text.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
<td>bool</td>
<td><ul class="first last simple">
<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
@@ -717,80 +810,108 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</ul>
</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
<td>string</td>
-<td><p class="first">How to treat range requests:</p>
-<ul class="last simple">
-<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
-<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
-<li>2 Use the cache_range_requests plugin.</li>
-</ul>
-</td>
+<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
-<td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td>
+<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
<td>string</td>
-<td>Entry points in to the CDN for this deliveryservice.</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
</tr>
</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">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"protocol"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"ccrDnsTtl"</span><span class="p">:</span> <span class="s">"3600"</span><span class="p">,</span>
- <span class="s">"checkPath"</span><span class="p">:</span> <span class="s">"/crossdomain.xml"</span><span class="p">,</span>
- <span class="s">"dnsBypassIp"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"dnsBypassIp6"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"dnsBypassTtl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"dscp"</span><span class="p">:</span> <span class="s">"40"</span><span class="p">,</span>
- <span class="s">"geoLimit"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"geoLimitRedirectURL"</span><span class="p">:</span><span class="s">""</span><span class="p">,</span>
- <span class="s">"globalMaxMbps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"globalMaxTps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"headerRewrite"</span><span class="p">:</span> <span class="s">"add-header X-Powered-By: KABLETOWN [L]"</span><span class="p">,</span>
- <span class="s">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="s">"add-header X-Powered-By: KABLETOWN [L]"</span><span class="p">,</span>
- <span class="s">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"httpBypassFqdn"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"rangeRequestHandling"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"12"</span><span class="p">,</span>
- <span class="s">"infoUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"longDesc"</span><span class="p">:</span> <span class="s">"long_desc"</span><span class="p">,</span>
- <span class="s">"longDesc1"</span><span class="p">:</span> <span class="s">"long_desc_1"</span><span class="p">,</span>
- <span class="s">"longDesc2"</span><span class="p">:</span> <span class="s">"long_desc_2"</span><span class="p">,</span>
- <span class="s">"matchList"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HOST_REGEXP"</span><span class="p">,</span>
- <span class="s">"setNumber"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">.images</span><span class="se">\\</span><span class="s">..*"</span>
- <span class="p">}</span>
- <span class="p">],</span>
- <span class="s">"maxDnsAnswers"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"missLat"</span><span class="p">:</span> <span class="s">"41.881944"</span><span class="p">,</span>
- <span class="s">"missLong"</span><span class="p">:</span> <span class="s">"-87.627778"</span><span class="p">,</span>
- <span class="s">"orgServerFqdn"</span><span class="p">:</span> <span class="s">"http://cdl.origin.kabletown.net"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for cdn2.comcast.net"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"EDGE_CDN2"</span><span class="p">,</span>
- <span class="s">"qstringIgnore"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"signed"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HTTP"</span><span class="p">,</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"cdl-c2"</span><span class="p">,</span>
- <span class="s">"exampleURLs"</span><span class="p">:</span> <span class="p">[]</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</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>
</div>
<div class="section" id="health">
<span id="to-api-v12-ds-health"></span><h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">�</a></h2>
@@ -822,6 +943,14 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">>destination</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -840,15 +969,18 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</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">"failover"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
- <span class="s">"destination"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"enabled"</span><span class="p">:</span> <span class="n">false</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">"failover"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
+ <span class="s2">"destination"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"location"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"DNS"</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="s2">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">},</span>
- <span class="s">"enabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -904,20 +1036,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -990,12 +1122,12 @@ delivery service that is down for maintenance.</td>
</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1032,9 +1164,9 @@ delivery service that is down for maintenance.</td>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="11%" />
+<col width="16%" />
<col width="5%" />
-<col width="83%" />
+<col width="79%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -1061,24 +1193,40 @@ delivery service that is down for maintenance.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cz</span></code></td>
<td>number</td>
-<td>The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF hit.</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF (coverage zone file) hit.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dsr</span></code></td>
<td>number</td>
<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the
client to the overflow CDN.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">fed</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to a federated CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionalAlternate</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to the alternate
+regional geoblocking URL.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalDenied</span></code></td>
+<td>number</td>
+<td>The percent of Traffic Router requests for this deliveryservice denied due to geolocation policy.</td>
+</tr>
</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"fed"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"regionalAlternate"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"regionalDenied"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1144,22 +1292,22 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
- <span class="s">"orderby"</span><span class="p">:</span> <span class="s">"deliveryservice"</span><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">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"orderby"</span><span class="p">:</span> <span class="s2">"deliveryservice"</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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:43"</span><span class="p">,</span>
- <span class="s">"server"</span><span class="p">:</span> <span class="s">"20"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:43"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"20"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:44"</span><span class="p">,</span>
- <span class="s">"server"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:44"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">},</span>
<span class="p">],</span>
- <span class="s">"limit"</span><span class="p">:</span> <span class="mi">2</span>
+ <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">2</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1268,20 +1416,20 @@ client to the overflow CDN.</td>
</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
<span class="p">},</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1391,20 +1539,20 @@ client to the overflow CDN.</td>
</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
<span class="p">},</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1478,8 +1626,8 @@ client to the overflow CDN.</td>
</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="s">"Successfully deleted ssl keys for <xml_id>"</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="s2">"Successfully deleted ssl keys for <xml_id>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1541,20 +1689,20 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"ds-01"</span><span class="p">,</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN Engineering"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
- <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"some_key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"some_csr"</span><span class="p">,</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"some_crt"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN Engineering"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span>
<span class="p">},</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"Kabletown"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"Kabletown"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1588,8 +1736,8 @@ client to the overflow CDN.</td>
</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="s">"Successfully created ssl keys for ds-01"</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="s2">"Successfully created ssl keys for ds-01"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1639,13 +1787,13 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"key"</sp
<TRUNCATED>
[32/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/deliveryservice_stats.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/deliveryservice_stats.html b/docs/1.7.0/development/traffic_ops_api/v12/deliveryservice_stats.html
index 61a26ed..562b368 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/deliveryservice_stats.html
+++ b/docs/1.7.0/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/1.7.0/development/traffic_ops_api/v12/division.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/division.html b/docs/1.7.0/development/traffic_ops_api/v12/division.html
index 2cbf37c..469bf82 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/division.html
+++ b/docs/1.7.0/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/1.7.0/development/traffic_ops_api/v12/federation.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/federation.html b/docs/1.7.0/development/traffic_ops_api/v12/federation.html
index 7fd13b6..5e99ff6 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/federation.html
+++ b/docs/1.7.0/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/1.7.0/development/traffic_ops_api/v12/hwinfo.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/hwinfo.html b/docs/1.7.0/development/traffic_ops_api/v12/hwinfo.html
index 3fffa7a..3dbd399 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/hwinfo.html
+++ b/docs/1.7.0/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/1.7.0/development/traffic_ops_api/v12/influxdb.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/influxdb.html b/docs/1.7.0/development/traffic_ops_api/v12/influxdb.html
index 4519e63..060dba3 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/influxdb.html
+++ b/docs/1.7.0/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/1.7.0/development/traffic_ops_api/v12/parameter.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/parameter.html b/docs/1.7.0/development/traffic_ops_api/v12/parameter.html
index d2c3be0..9e264e4 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/parameter.html
+++ b/docs/1.7.0/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>
[24/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.txt b/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.txt
index b673a00..73d8ffd 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.txt
@@ -25,7 +25,7 @@ Delivery Service
/api/1.1/deliveryservices
+++++++++++++++++++++++++
-**GET /api/1.1/deliveryservices.json**
+**GET /api/1.1/deliveryservices**
Retrieves all delivery services. See also `Using Traffic Ops - Delivery Service <http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
@@ -35,172 +35,224 @@ Delivery Service
**Response Properties**
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description | |
- +==========================+========+======================================================================================================================================+=====================================================================================================+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``active`` | bool | true if active, false if inactive. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE | |
- | | | - 1: serve with https:// at EDGE | |
- | | | - 2: serve with both http:// and https:// at EDGE | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | string | - 0: None - no limitations | |
- | | | - 1: Only route on CZF file hit | |
- | | | - 2: Only route on CZF hit or when from USA | |
- | | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents | |
- | | | routing to the content by Traffic Router. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the | |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded | |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for | |
- | | | HTTP deliveryservices | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``headerRewrite`` | string | The EDGE header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``id`` | string | The deliveryservice id (database row number). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field 1. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 2. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``matchList`` | array | Array of matchList hashes. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all | |
- | | | available). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | string | | Is the Multi Site Origin feature enabled for this delivery service. See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the | |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. | |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. | |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. | |
- | | | - true: token based auth is enabled for this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: | |
- | | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) | |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. | |
- | | | - 2 Use the cache_range_requests plugin. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | string | Entry points into the CDN for this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
- },
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
{ .. },
{ .. }
- ],
+ ]
}
-
|
-**GET /api/1.1/deliveryservices/:id.json**
+
+**GET /api/1.1/deliveryservices/:id**
Retrieves a specific delivery service. See also `Using Traffic Ops - Delivery Service <http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
@@ -213,20 +265,20 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+========+======================================================================================================================================+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``active`` | bool | true if active, false if inactive. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -239,6 +291,10 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimit`` | string | - 0: None - no limitations |
| | | - 1: Only route on CZF file hit |
| | | - 2: Only route on CZF hit or when from USA |
@@ -246,6 +302,10 @@ Delivery Service
| | | Note that this does not prevent access to content or makes content secure; it just prevents |
| | | routing to the content by Traffic Router. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
| | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -253,8 +313,6 @@ Delivery Service
| | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
| | | HTTP deliveryservices |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``headerRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -262,8 +320,14 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc`` | string | Description field 1. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc1`` | string | Description field 2. |
@@ -281,96 +345,138 @@ Delivery Service
| ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
| | | available). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
| | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
| | | - 2: drop query string at edge, and do not use it in the cache-key. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``remapText`` | string | Additional raw remap line text. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
| | | - true: token based auth is enabled for this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | string | Entry points in to the CDN for this deliveryservice. |
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
-
{
"response": [
{
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
}
- ],
+ ]
}
|
+
.. _to-api-v11-ds-health:
Health
[06/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
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>
[02/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/static_dns.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/static_dns.html b/docs/latest/development/traffic_ops_api/v12/static_dns.html
index 1e1b990..d864758 100644
--- a/docs/latest/development/traffic_ops_api/v12/static_dns.html
+++ b/docs/latest/development/traffic_ops_api/v12/static_dns.html
@@ -235,18 +235,18 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "deliveryservice": "foo-ds",
- "ttl": "30",
- "type": "CNAME_RECORD",
- "address": "bar.foo.baz.tv.",
- "cachegroup": "us-co-denver",
- "host": "mm"
- }
- ]
-}
+<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">"deliveryservice"</span><span class="p">:</span> <span class="s2">"foo-ds"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CNAME_RECORD"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"bar.foo.baz.tv."</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span><span class="p">,</span>
+ <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"mm"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/status.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/status.html b/docs/latest/development/traffic_ops_api/v12/status.html
index d67e3f6..3618cea 100644
--- a/docs/latest/development/traffic_ops_api/v12/status.html
+++ b/docs/latest/development/traffic_ops_api/v12/status.html
@@ -190,9 +190,9 @@
<span id="to-api-v12-status"></span><h1>Status<a class="headerlink" href="#status" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-statuses">
<span id="to-api-v12-statuses-route"></span><h2>/api/1.2/statuses<a class="headerlink" href="#api-1-2-statuses" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/statuses.json</strong></p>
+<p><strong>GET /api/1.2/statuses</strong></p>
<blockquote>
-<div><p>Retrieves a list of the server status codes available. May be useful when the status is retrieved from other APIs as a number and not a string.</p>
+<div><p>Retrieves a list of the server status codes available.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
@@ -209,65 +209,133 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>The Time / Date this server entry was last updated</td>
+<td>The id with which Traffic Ops stores this status, and references it internally</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The string equivalent of the status</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>A short description of the status</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</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">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_IGNORE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</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">"name"</span><span class="p">:</span> <span class="s2">"OFFLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</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="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"REPORTED"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.2/statuses/:id</strong></p>
+<blockquote>
+<div><p>Retrieves a server status by ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Status id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="8%" />
+<col width="76%" />
+</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>The id with which Traffic Ops stores this status, and references it internally</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The string equivalent of the status</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
<td>string</td>
<td>A short description of the status</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
- "id": "4",
- "name": "ADMIN_DOWN",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "CCR_IGNORE",
- "id": "5",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"
- },
- {
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
- "id": "1",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "OFFLINE"
- },
- {
- "id": "2",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "ONLINE"
- },
- {
- "id": "3",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
- "name": "REPORTED",
- "lastUpdated": "2013-02-13 16:34:29"
- }
- ],
-}
+<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">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</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>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/system.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/system.html b/docs/latest/development/traffic_ops_api/v12/system.html
index 944c776..6c74537 100644
--- a/docs/latest/development/traffic_ops_api/v12/system.html
+++ b/docs/latest/development/traffic_ops_api/v12/system.html
@@ -252,16 +252,16 @@ set this parameter on a production system.</td>
</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">"parameters"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"tm.toolname"</span><span class="p">:</span> <span class="s">"Traffic Ops"</span><span class="p">,</span>
- <span class="s">"tm.infourl"</span><span class="p">:</span> <span class="s">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
- <span class="s">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s">"tm.logourl"</span><span class="p">:</span> <span class="s">"\/images\/tc_logo.png"</span><span class="p">,</span>
- <span class="s">"tm.url"</span><span class="p">:</span> <span class="s">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
- <span class="s">"tm.instance_name"</span><span class="p">:</span> <span class="s">"Kabletown CDN"</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">"parameters"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"tm.toolname"</span><span class="p">:</span> <span class="s2">"Traffic Ops"</span><span class="p">,</span>
+ <span class="s2">"tm.infourl"</span><span class="p">:</span> <span class="s2">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
+ <span class="s2">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"tm.logourl"</span><span class="p">:</span> <span class="s2">"\/images\/tc_logo.png"</span><span class="p">,</span>
+ <span class="s2">"tm.url"</span><span class="p">:</span> <span class="s2">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
+ <span class="s2">"tm.instance_name"</span><span class="p">:</span> <span class="s2">"Kabletown CDN"</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/to_extension.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/to_extension.html b/docs/latest/development/traffic_ops_api/v12/to_extension.html
index a92f5ec..80a0708 100644
--- a/docs/latest/development/traffic_ops_api/v12/to_extension.html
+++ b/docs/latest/development/traffic_ops_api/v12/to_extension.html
@@ -251,34 +251,34 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- script_file: "ping",
- version: "1.0.0",
- name: "ILO_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
- isactive: "1",
- id: "1",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "ILO"
- },
- {
- script_file: "ping",
- version: "1.0.0",
- name: "10G_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
- isactive: "1",
- id: "2",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "10G"
- }
- ],
-}
+<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="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ilo_ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">9</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&
quot;</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"10G_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&quo
t;</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"10G"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
<div class="line-block">
@@ -342,17 +342,17 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "name": "ILO_PING",
- "version": "1.0.0",
- "info_url": "http://foo.com/bar.html",
- "script_file": "ping",
- "isactive": "1",
- "additional_config_json": "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}",
- "description": null,
- "servercheck_short_name": "ILO"
- "type": "CHECK_EXTENSION_BOOL",
-}
+<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">"ILO_PING"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="s2">"info_url"</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="s2">"script_file"</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="s2">"isactive"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"additional_config_json"</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -389,11 +389,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Check Extension loaded."</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">"Check Extension loaded."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -457,11 +457,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Extension deleted."</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">"Extension deleted."</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/topology.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/topology.html b/docs/latest/development/traffic_ops_api/v12/topology.html
index 88e3e89..b5f1444 100644
--- a/docs/latest/development/traffic_ops_api/v12/topology.html
+++ b/docs/latest/development/traffic_ops_api/v12/topology.html
@@ -235,8 +235,8 @@
</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="s">"SUCCESS"</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="s2">"SUCCESS"</span>
<span class="p">}</span>
</pre></div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/type.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/type.html b/docs/latest/development/traffic_ops_api/v12/type.html
index 4ec156c..44de028 100644
--- a/docs/latest/development/traffic_ops_api/v12/type.html
+++ b/docs/latest/development/traffic_ops_api/v12/type.html
@@ -190,10 +190,30 @@
<span id="to-api-v12-type"></span><h1>Types<a class="headerlink" href="#types" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-types">
<span id="to-api-v12-types-route"></span><h2>/api/1.2/types<a class="headerlink" href="#api-1-2-types" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/types.json</strong></p>
+<p><strong>GET /api/1.1/types</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
-<p>Role(s) Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="67%" />
+</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">useInTable</span></code></td>
+<td>no</td>
+<td>Filter types by the table in which they apply</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -208,39 +228,39 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</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>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</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>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<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-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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-10-23 15:28:31"</span><span class="p">,</span>
- <span class="s">"useInTable"</span><span class="p">:</span> <span class="s">"staticdnsentry"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Static DNS AAAA entry"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -248,7 +268,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/types/trimmed.json</strong></p>
+<p><strong>GET /api/1.1/types/trimmed</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -273,25 +293,100 @@
</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">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"ACTIVE_DIRECTORY"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ACTIVE_DIRECTORY"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"A_RECORD"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"A_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
+<p><strong>GET /api/1.1/types/:id</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="21%" />
+<col width="13%" />
+<col width="67%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Type ID.</td>
+</tr>
+</tbody>
+</table>
+<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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</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">"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">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</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>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/user.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/user.html b/docs/latest/development/traffic_ops_api/v12/user.html
index 8fdb99e..71e28a7 100644
--- a/docs/latest/development/traffic_ops_api/v12/user.html
+++ b/docs/latest/development/traffic_ops_api/v12/user.html
@@ -190,17 +190,154 @@
<span id="to-api-v12-users"></span><h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-users">
<span id="to-api-v12-users-route"></span><h2>/api/1.2/users<a class="headerlink" href="#api-1-2-users" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/users.json</strong></p>
+<p><strong>GET /api/1.2/users</strong></p>
<blockquote>
<div><p>Retrieves all users.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
-<p><strong>Request Query Parameters</strong></p>
+<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="22%" />
-<col width="13%" />
-<col width="65%" />
+<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">addressLine1</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>hash</td>
+<td> </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">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</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">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">users</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/users/:id</strong></p>
+<blockquote>
+<div><p>Retrieves user by ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
@@ -209,9 +346,9 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td>username</td>
-<td>no</td>
-<td>The user you want to retrieve information for.</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>User id.</td>
</tr>
</tbody>
</table>
@@ -219,8 +356,8 @@
<table border="1" class="docutils">
<colgroup>
<col width="28%" />
-<col width="11%" />
-<col width="61%" />
+<col width="10%" />
+<col width="62%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -229,27 +366,27 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>hash</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -257,27 +394,35 @@
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">localUser</span></code></td>
-<td>boolean</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>hash</td>
+<td> </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-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">newUser</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rolename</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td>
-<td>boolean</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -285,43 +430,54 @@
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td>
<td>string</td>
<td> </td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">[</span>
- <span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"54"</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Bob Simpson"</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"bsimpson"</span><span class="p">,</span>
- <span class="s">"rolename"</span><span class="p">:</span> <span class="s">"portal"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</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="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">users</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
<span class="p">}</span>
-<span class="p">]</span>
</pre></div>
</div>
</div></blockquote>
@@ -418,25 +574,25 @@
</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">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"50"</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Callahan"</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</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">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"50"</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Callahan"</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -535,25 +691,25 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -596,11 +752,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"UserProfile was successfully updated."</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">"UserProfile was successfully updated."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -712,23 +868,23 @@
</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">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"keyword"</span><span class="p">:</span> <span class="s">"PURGE"</span><span class="p">,</span>
- <span class="s">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"assetUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"assetType"</span><span class="p">:</span> <span class="s">"file"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"PENDING"</span><span class="p">,</span>
- <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
- <span class="s">"dsXmlId"</span><span class="p">:</span> <span class="s">"ds-xml-id"</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"peewee"</span><span class="p">,</span>
- <span class="s">"parameters"</span><span class="p">:</span> <span class="s">"TTL:56h"</span><span class="p">,</span>
- <span class="s">"enteredTime"</span><span class="p">:</span> <span class="s">"2015-01-21 18:00:16"</span><span class="p">,</span>
- <span class="s">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"agent"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-21 10:45:38"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span>
+ <span class="s2">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"assetType"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"PENDING"</span><span class="p">,</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"dsXmlId"</span><span class="p">:</span> <span class="s2">"ds-xml-id"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"peewee"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:56h"</span><span class="p">,</span>
+ <span class="s2">"enteredTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 18:00:16"</span><span class="p">,</span>
+ <span class="s2">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"agent"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 10:45:38"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -742,7 +898,7 @@
<p>Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the <em>regex_revalidate</em> ATS plugin. This forces a <em>revalidation</em> of the content, rather than a new get.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">This method forces a HTTP <em>revalidation</em> of the content, and not a new <em>GET</em> - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> or <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> as applicable.</p>
+<p class="last">This method forces a HTTP <em>revalidation</em> of the content, and not a new <em>GET</em> - the origin needs to support revalidation according to the HTTP/1.2 specification, and send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> or <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> as applicable.</p>
</div>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -797,11 +953,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
- <span class="s">"regex"</span><span class="p">:</span> <span class="s">"/path/to/content.jpg"</span><span class="p">,</span>
- <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-27 11:08:37"</span><span class="p">,</span>
- <span class="s">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"regex"</span><span class="p">:</span> <span class="s2">"/path/to/content.jpg"</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-27 11:08:37"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -843,12 +999,12 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span>
+<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="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully created purge job for: ."</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">"Successfully created purge job for: ."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -888,9 +1044,9 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"u"</span><span class="p">:</span> <span class="s">"username"</span><span class="p">,</span>
- <span class="s">"p"</span><span class="p">:</span> <span class="s">"password"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"u"</span><span class="p">:</span> <span class="s2">"username"</span><span class="p">,</span>
+ <span class="s2">"p"</span><span class="p">:</span> <span class="s2">"password"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -932,11 +1088,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully logged in."</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">"Successfully logged in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -995,15 +1151,15 @@ unnecessary work.</td>
</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">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"90"</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"90"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img-secure"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"280"</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img-secure"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"280"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1039,8 +1195,8 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"t"</span><span class="p">:</span> <span class="s">"token-value"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"token-value"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1082,11 +1238,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"error"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Unauthorized, please log in."</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Unauthorized, please log in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1140,11 +1296,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"You are logged out."</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">"You are logged out."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1181,8 +1337,8 @@ password reset.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1230,11 +1386,11 @@ password reset.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully sent password reset to email 'email@email.com'"</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">"Successfully sent password reset to email 'email@email.com'"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
[46/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/division.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/division.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/division.txt
index 2110b00..2d9403a 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/division.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/division.txt
@@ -22,7 +22,141 @@ Divisions
.. _to-api-v12-division-route:
/api/1.2/divisions
-++++++++++++++++++
+++++++++++++++++
+
+**GET /api/1.2/divisions**
+ Get all divisions.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "West",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/divisions/:id**
+ Get division by Id.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**PUT /api/1.2/divisions/:id**
+ Update a division
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Division id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-----------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+==========================+
+ | ``name`` | yes | The name of the division |
+ +-----------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "mydivision1"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Division update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "mydivision1"
+ }
+ }
+|
+
**POST /api/1.2/divisions**
Create division
@@ -38,7 +172,7 @@ Divisions
+===========+==========+==========================+
| ``name`` | yes | The name of the division |
+-----------+----------+--------------------------+
-
+
**Request Example** ::
{
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/parameter.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/parameter.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/parameter.txt
index 818205c..81c00c3 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/parameter.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/parameter.txt
@@ -24,7 +24,7 @@ Parameter
/api/1.2/parameters
+++++++++++++++++++
-**GET /api/1.2/parameters.json**
+**GET /api/1.2/parameters**
Authentication Required: Yes
@@ -52,21 +52,21 @@ Parameter
"response": [
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": false,
"value": "foo.bar.net",
"name": "domain_name",
"config_file": "FooConfig.xml"
},
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": false,
"value": "0,1,2,3,4,5,6",
"name": "Drive_Letters",
"config_file": "storage.config"
},
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": true,
"value": "STRING __HOSTNAME__",
"name": "CONFIG proxy.config.proxy_name",
"config_file": "records.config"
@@ -76,7 +76,46 @@ Parameter
|
-**GET /api/1.2/parameters/profile/:name.json**
+**GET /api/1.2/parameters/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: if secure of the parameter fetched is 1, require admin role, or any valid role can access.
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "id": "27",
+ "config_file": "FooConfig.xml",
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/profiles/:id/parameters**
Authentication Required: Yes
@@ -84,11 +123,11 @@ Parameter
**Request Route Parameters**
- +------------------+----------+-------------+
- | Name | Required | Description |
- +==================+==========+=============+
- | ``profile_name`` | yes | |
- +------------------+----------+-------------+
+ +------------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==================+==========+=======================+
+ | ``id`` | yes | Profile id |
+ +------------------+----------+-----------------------+
**Response Properties**
@@ -112,21 +151,21 @@ Parameter
"response": [
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": false,
"value": "foo.bar.net",
"name": "domain_name",
"config_file": "FooConfig.xml"
},
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": false,
"value": "0,1,2,3,4,5,6",
"name": "Drive_Letters",
"config_file": "storage.config"
},
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": true,
"value": "STRING __HOSTNAME__",
"name": "CONFIG proxy.config.proxy_name",
"config_file": "records.config"
@@ -135,3 +174,344 @@ Parameter
}
|
+
+**GET /api/1.2/profiles/name/:name/parameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==================+==========+=======================+
+ | ``name`` | yes | Profile name |
+ +------------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": true,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/parameters**
+ Create parameters.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+ The request route parameters accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ parameters array format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+=========+======================================================================================+
+ | | array | parameters array |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>id`` | integer | The parameter id |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | string | parameter name |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | string | parameter config_file |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | string | parameter value |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+
+
+ **Request Example** ::
+
+ 1. single parameter format exampe:
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":0,
+ }
+
+ 2. array format example:
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":1,
+ }
+ ]
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "value":"value1",
+ "secure":0,
+ "name":"param1",
+ "id":"1139",
+ "configFile":"configFile1"
+ },
+ {
+ "value":"value2",
+ "secure":1,
+ "name":"param2",
+ "id":"1140",
+ "configFile":"configFile2"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/parameters/{:id}**
+ Edit parameter.
+
+ Authentication Required: Yes
+
+ 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.
+
+ **Request Parameters**
+
+ +-----------+---------+------------------+
+ | Parameter | Type | Description |
+ +===========+=========+==================+
+ | ``id`` | integer | The parameter id |
+ +-----------+---------+------------------+
+
+ **Request Route Parameters**
+
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+=========+======================================================================================+
+ | ``name`` | no | string | parameter name |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | no | string | parameter config_file |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | no | string | parameter value |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | no | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter id |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ }
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "value":"value1",
+ "secure":"0",
+ "name":"param1",
+ "id":"1134",
+ "configFile":"configFile1"
+ }
+ }
+
+|
+
+**DELETE /api/1.2/parameters/{:id}**
+ delete parameter. If the parameter have profile associated, can not be deleted.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper role
+
+ **Request Parameters**
+
+ +-----------+---------+------------------+
+ | Parameter | Type | Description |
+ +===========+=========+==================+
+ | ``id`` | integer | The parameter id |
+ +-----------+---------+------------------+
+
+ **No Request Route Parameters**
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ Response Example:
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Parameter was successfully deleted."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/parameters/validate**
+ Validate if the parameter exists.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+--------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+================================+
+ | ``name`` | yes | string | parameter name |
+ +----------------+----------+--------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +----------------+----------+--------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +----------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter id |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ }
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "value":"value1",
+ "secure":"0",
+ "name":"param1",
+ "id":"1134",
+ "configFile":"configFile1"
+ }
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/phys_location.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/phys_location.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/phys_location.txt
index ef05085..53c561f 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/phys_location.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/phys_location.txt
@@ -24,7 +24,7 @@ Physical Location
/api/1.2/phys_locations
+++++++++++++++++++++++
-**GET /api/1.2/phys_locations.json**
+**GET /api/1.2/phys_locations**
Authentication Required: Yes
@@ -35,30 +35,34 @@ Physical Location
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``region`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``poc`` | string | |
+ |``address`` | string | |
+----------------------+--------+------------------------------------------------+
- |``name`` | string | |
+ |``city`` | string | |
+----------------------+--------+------------------------------------------------+
|``comments`` | string | |
+----------------------+--------+------------------------------------------------+
- |``phone`` | string | |
+ |``email`` | string | |
+----------------------+--------+------------------------------------------------+
- |``state`` | string | |
+ |``id`` | string | |
+----------------------+--------+------------------------------------------------+
- |``email`` | string | |
+ |``lastUpdated`` | string | |
+----------------------+--------+------------------------------------------------+
- |``city`` | string | |
+ |``name`` | string | |
+----------------------+--------+------------------------------------------------+
- |``zip`` | string | |
+ |``phone`` | string | |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
+ |``poc`` | string | |
+----------------------+--------+------------------------------------------------+
- |``address`` | string | |
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+----------------------+--------+------------------------------------------------+
|``shortName`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
@@ -66,7 +70,9 @@ Physical Location
"response": [
{
"region": "Mile High",
+ "region": "4",
"poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
"name": "Albuquerque",
"comments": "Albuquerque",
"phone": "(123) 555-1111",
@@ -79,20 +85,22 @@ Physical Location
"shortName": "Albuquerque"
},
{
- "region": "Chicago",
- "poc": "John Doe",
- "name": "Chicago",
- "comments": "",
- "phone": "(321) 555-1111",
- "state": "IL",
- "email": "john.doe@email.com",
- "city": "Chicago",
- "zip": "60636",
- "id": "3",
- "address": "123 East 4th Street",
- "shortName": "chicago"
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
}
- ],
+ ]
}
|
@@ -126,6 +134,209 @@ Physical Location
|
+
+**GET /api/1.2/phys_locations/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Physical location ID. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/phys_locations/:id**
+ Update a physical location
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Physical location id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+================================================+
+ | ``address`` | yes | Physical location address. |
+ +-------------------+----------+------------------------------------------------+
+ | ``city`` | yes | Physical location city. |
+ +-------------------+----------+------------------------------------------------+
+ | ``comments`` | no | Physical location comments. |
+ +-------------------+----------+------------------------------------------------+
+ | ``email`` | no | Physical location email. |
+ +-------------------+----------+------------------------------------------------+
+ | ``name`` | yes | Physical location name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``phone`` | no | Physical location phone. |
+ +-------------------+----------+------------------------------------------------+
+ | ``poc`` | no | Physical location point of contact. |
+ +-------------------+----------+------------------------------------------------+
+ | ``regionId`` | no | Physical location region ID. |
+ +-------------------+----------+------------------------------------------------+
+ | ``shortName`` | yes | Physical location short name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``state`` | yes | Physical location state. |
+ +-------------------+----------+------------------------------------------------+
+ | ``zip`` | yes | Physical location zip. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "regionId": "1",
+ "poc": "Jane Doesssss",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "address": "123 East 9rd St",
+ "shortName": "Albuquerque"
+ }
+
+|
+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Physical location update was successful."
+ }
+ ],
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+
**POST /api/1.2/regions/:region_name/phys_locations**
Create physical location.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/profile.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/profile.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/profile.txt
index 82cb5ae..5892272 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/profile.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/profile.txt
@@ -25,12 +25,20 @@ Profiles
/api/1.2/profiles
+++++++++++++++++
-**GET /api/1.2/profiles.json**
+**GET /api/1.2/profiles**
Authentication Required: Yes
Role(s) Required: None
+ **Request Query Parameters**
+
+ +---------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+====================================================+
+ | ``param`` | no | Used to filter profiles by parameter. |
+ +---------------+----------+----------------------------------------------------+
+
**Response Properties**
+-----------------+--------+----------------------------------------------------+
@@ -60,7 +68,7 @@ Profiles
|
-**GET /api/1.2/profiles/trimmed.json**
+**GET /api/1.2/profiles/trimmed**
Authentication Required: Yes
@@ -86,6 +94,50 @@ Profiles
|
+**GET /api/1.2/profiles/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+------------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+============+================================================+
+ | ``id`` | yes | The ID of the profile. |
+ +-----------------+------------+------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
+
**POST /api/1.2/profiles**
Create a new empty profile.
@@ -187,3 +239,120 @@ Profiles
}
|
+
+**PUT /api/1.2/profiles/{:id}**
+
+ Allows user to edit a profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | profile id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Properties**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | yes | The new name for the profile. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``description`` | yes | The new description for the profile. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "CCR_UPDATE",
+ "description": "CCR_UPDATE description"
+ }
+
+ **Response Properties**
+
+ +------------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+==================================+
+ | ``response`` | | The updated profile info. |
+ +------------------+--------+----------------------------------+
+ | ``>id`` | string | Profile id. |
+ +------------------+--------+----------------------------------+
+ | ``>name`` | string | Profile name. |
+ +------------------+--------+----------------------------------+
+ | ``>description`` | string | Profile description. |
+ +------------------+--------+----------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+--------+----------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +------------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": "219",
+ "name": "CCR_UPDATE",
+ "description": "CCR_UPDATE description"
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile was updated: 219"
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/profiles/{:id}**
+
+ Allows user to delete a profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+----------------------------+
+ | Name | Required | Description |
+ +=================+==========+============================+
+ | ``id`` | yes | profile id. |
+ +-----------------+----------+----------------------------+
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Profile was deleted."
+ }
+ ]
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/profile_parameter.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/profile_parameter.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/profile_parameter.txt
new file mode 100644
index 0000000..bc16128
--- /dev/null
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/profile_parameter.txt
@@ -0,0 +1,458 @@
+..
+.. Copyright 2015 Comcast Cable Communications Management, LLC
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-profileparameters:
+
+
+Profile parameters
+==================
+
+.. _to-api-v12-profileparameters-route:
+
+/api/1.2/profileparameters
+++++++++++++++++++++++++++
+
+**POST /api/1.2/profileparameters**
+
+ Associate parameter to profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+ This accept two formats: single profile-parameter, profile-parameter array.
+
+ Single profile-parameter format:
+
+ +------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +==================+==========+====================================================+
+ | ``profileId`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameterId`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ Profile-parameter array format:
+
+ +------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +==================+==========+====================================================+
+ | | yes | profile-parameter array. |
+ +------------------+----------+----------------------------------------------------+
+ | ``>profileId`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``>parameterId`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ Single profile-parameter format:
+
+ {
+ "profileId": 2,
+ "parameterId": 6
+ }
+
+ Profile-parameter array format:
+
+ [
+ {
+ "profileId": 2,
+ "parameterId": 6
+ },
+ {
+ "profileId": 2,
+ "parameterId": 7
+ },
+ {
+ "profileId": 3,
+ "parameterId": 6
+ }
+ ]
+
+ **Response Properties**
+
+ +-------------------+---------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+=========+=====================================================+
+ | ``response`` | array | Profile-parameter associations. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>profileId`` | string | Profile id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>parameterId`` | string | Parameter id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+---------+-----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":[
+ {
+ "profileId": "2",
+ "parameterId": "6"
+ },
+ {
+ "profileId": "2",
+ "parameterId": "7"
+ },
+ {
+ "profileId": "3",
+ "parameterId": "6"
+ }
+ ]
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile parameter associations were created."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/profileparameters/{:profile_id}/{:parameter_id}**
+
+ Delete a profile parameter association.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+====================================================+
+ | ``profile_id`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameter_id`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=====================================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+--------+-----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile parameter association was deleted."
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/name/{:name}/parameters**
+
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+ If the profile does not exist, the API returns fail.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+
+ **Request Route Parameters**
+
+ +------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +============+==========+====================================================+
+ | ``name`` | yes | profile name. |
+ +------------+----------+----------------------------------------------------+
+
+ **Request Properties**
+ The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ array parameters format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ 1. single parameter format exampe:
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ }
+
+ 2. array format example:
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1,
+ }
+ ]
+
+
+ **Response Properties** ::
+
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | Name | Type | Description |
+ +==================+=========+======================================================================================+
+ | ``response`` | | Parameters associated with the profile. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileName`` | string | profile name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileId`` | integer | profile index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>parameters`` | array | parameters array |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>id`` | integer | parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>name`` | string | parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>configFile`` | string | parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>value`` | string | parameter value |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``version`` | string | |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/id/{:id}/parameters**
+
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+ If the profile does not exist, the API returns fail.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+
+ **Request Route Parameters**
+
+ +------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +============+==========+====================================================+
+ | ``id`` | yes | profile name. |
+ +------------+----------+----------------------------------------------------+
+
+ **Request Properties**
+ The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ array parameters format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ 1. single parameter format exampe:
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ }
+
+ 2. array format example:
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1,
+ }
+ ]
+
+
+ **Response Properties** ::
+
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | Name | Type | Description |
+ +==================+=========+======================================================================================+
+ | ``response`` | | Parameters associated with the profile. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileName`` | string | profile name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileId`` | integer | profile index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>parameters`` | array | parameters array |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>id`` | integer | parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>name`` | string | parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>configFile`` | string | parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>value`` | string | parameter value |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``version`` | string | |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/region.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/region.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/region.txt
index fc1e927..8129854 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/region.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/region.txt
@@ -24,7 +24,7 @@ Regions
/api/1.2/regions
++++++++++++++++
-**GET /api/1.2/regions.json**
+**GET /api/1.1/regions**
Authentication Required: Yes
@@ -35,9 +35,13 @@ Regions
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``name`` | string | |
+ |``id`` | string | Region ID. |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+----------------------+--------+------------------------------------------------+
**Response Example** ::
@@ -45,18 +49,132 @@ Regions
{
"response": [
{
+ "id": "6",
"name": "Atlanta",
- "id": "6"
+ "division": "2",
+ "divisionName": "West"
},
{
- "name": "Beltway",
- "id": "1"
+ "id": "7",
+ "name": "Denver",
+ "division": "2",
+ "divisionName": "West"
+ },
+ ]
+ }
+
+
+**GET /api/1.1/regions/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Region id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
}
- ],
+ ]
+ }
+
+
+**PUT /api/1.2/regions/:id**
+ Update a region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Region id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +================+==========+==========================+
+ | ``name`` | yes | The name of the region |
+ +----------------+----------+--------------------------+
+ | ``division`` | yes | The division Id |
+ +----------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ "division": "4"
}
|
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``division`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Region update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "myregion1",
+ "division": "4",
+ "divisionName": "mydivision1"
+ }
+ }
+|
+
**POST /api/1.2/divisions/:division_name/regions**
Create Region
[49/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v11/phys_location.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v11/phys_location.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v11/phys_location.txt
index 01987eb..61d6c0b 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v11/phys_location.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v11/phys_location.txt
@@ -24,7 +24,7 @@ Physical Location
/api/1.1/phys_locations
+++++++++++++++++++++++
-**GET /api/1.1/phys_locations.json**
+**GET /api/1.1/phys_locations**
Authentication Required: Yes
@@ -35,30 +35,34 @@ Physical Location
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``region`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``poc`` | string | |
+ |``address`` | string | |
+----------------------+--------+------------------------------------------------+
- |``name`` | string | |
+ |``city`` | string | |
+----------------------+--------+------------------------------------------------+
|``comments`` | string | |
+----------------------+--------+------------------------------------------------+
- |``phone`` | string | |
+ |``email`` | string | |
+----------------------+--------+------------------------------------------------+
- |``state`` | string | |
+ |``id`` | string | |
+----------------------+--------+------------------------------------------------+
- |``email`` | string | |
+ |``lastUpdated`` | string | |
+----------------------+--------+------------------------------------------------+
- |``city`` | string | |
+ |``name`` | string | |
+----------------------+--------+------------------------------------------------+
- |``zip`` | string | |
+ |``phone`` | string | |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
+ |``poc`` | string | |
+----------------------+--------+------------------------------------------------+
- |``address`` | string | |
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+----------------------+--------+------------------------------------------------+
|``shortName`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
@@ -66,7 +70,9 @@ Physical Location
"response": [
{
"region": "Mile High",
+ "region": "4",
"poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
"name": "Albuquerque",
"comments": "Albuquerque",
"phone": "(123) 555-1111",
@@ -79,20 +85,22 @@ Physical Location
"shortName": "Albuquerque"
},
{
- "region": "Chicago",
- "poc": "John Doe",
- "name": "Chicago",
- "comments": "",
- "phone": "(321) 555-1111",
- "state": "IL",
- "email": "john.doe@email.com",
- "city": "Chicago",
- "zip": "60636",
- "id": "3",
- "address": "123 East 4th Street",
- "shortName": "chicago"
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
}
- ],
+ ]
}
|
@@ -121,7 +129,322 @@ Physical Location
{
"name": "Ashburn"
}
- ],
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/phys_locations/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Physical location ID. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
}
+|
+
+**PUT /api/1.1/phys_locations/:id**
+ Update a physical location
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Physical location id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+================================================+
+ | ``address`` | yes | Physical location address. |
+ +-------------------+----------+------------------------------------------------+
+ | ``city`` | yes | Physical location city. |
+ +-------------------+----------+------------------------------------------------+
+ | ``comments`` | no | Physical location comments. |
+ +-------------------+----------+------------------------------------------------+
+ | ``email`` | no | Physical location email. |
+ +-------------------+----------+------------------------------------------------+
+ | ``name`` | yes | Physical location name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``phone`` | no | Physical location phone. |
+ +-------------------+----------+------------------------------------------------+
+ | ``poc`` | no | Physical location point of contact. |
+ +-------------------+----------+------------------------------------------------+
+ | ``regionId`` | no | Physical location region ID. |
+ +-------------------+----------+------------------------------------------------+
+ | ``shortName`` | yes | Physical location short name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``state`` | yes | Physical location state. |
+ +-------------------+----------+------------------------------------------------+
+ | ``zip`` | yes | Physical location zip. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "regionId": "1",
+ "poc": "Jane Doesssss",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "address": "123 East 9rd St",
+ "shortName": "Albuquerque"
+ }
+
+|
+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Physical location update was successful."
+ }
+ ],
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.1/regions/:region_name/phys_locations**
+ Create physical location.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ region_name: the name of the region to create physical location into.
+
+ **Request Route Parameters**
+
+ +-----------------+----------+-----------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================+
+ | ``region_name`` | yes | The name of the physical location |
+ +-----------------+----------+-----------------------------------+
+
+ **Request Properties**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | yes | The name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``shortName`` | yes | The short name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``address`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``city`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``state`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``zip`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``phone`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``poc`` | no | Point of contact |
+ +-----------------+----------+---------------------------------------------------+
+ | ``email`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``comments`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name" : "my physical location1",
+ "shortName" : "myphylocation1",
+ "address" : "",
+ "city" : "Shanghai",
+ "state": "SH",
+ "zip": "200000",
+ "comments": "this is physical location1"
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------+--------+---------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+===================================================+
+ | ``id`` | string | The id of the physical location created. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``name`` | string | The name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``shortName`` | string | The short name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionName`` | string | The region name the physical location belongs to. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionId`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``address`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``city`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``state`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``zip`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``phone`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``poc`` | string | Point of contact |
+ +-----------------+--------+---------------------------------------------------+
+ | ``email`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``comments`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'shortName': 'myphylocati',
+ 'regionName': 'myregion1',
+ 'name': 'my physical location1',
+ 'poc': '',
+ 'phone': '',
+ 'comments': 'this is physical location1',
+ 'state': 'SH',
+ 'email': '',
+ 'zip': '20000',
+ 'region_id': '20',
+ 'city': 'Shanghai',
+ 'address': '',
+ 'id': '200'
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v11/profile.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v11/profile.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v11/profile.txt
index 83d54f2..97075d8 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v11/profile.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v11/profile.txt
@@ -24,7 +24,7 @@ Profiles
/api/1.1/profiles
+++++++++++++++++
-**GET /api/1.1/profiles.json**
+**GET /api/1.1/profiles**
Authentication Required: Yes
@@ -59,7 +59,7 @@ Profiles
|
-**GET /api/1.1/profiles/trimmed.json**
+**GET /api/1.1/profiles/trimmed**
Authentication Required: Yes
@@ -84,3 +84,47 @@ Profiles
}
|
+
+**GET /api/1.1/profiles/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+------------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+============+================================================+
+ | ``id`` | yes | The ID of the profile. |
+ +-----------------+------------+------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v11/region.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v11/region.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v11/region.txt
index f7d993d..7eda251 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v11/region.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v11/region.txt
@@ -24,7 +24,7 @@ Regions
/api/1.1/regions
++++++++++++++++
-**GET /api/1.1/regions.json**
+**GET /api/1.1/regions**
Authentication Required: Yes
@@ -35,9 +35,13 @@ Regions
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``name`` | string | |
+ |``id`` | string | Region ID. |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+----------------------+--------+------------------------------------------------+
**Response Example** ::
@@ -45,13 +49,188 @@ Regions
{
"response": [
{
+ "id": "6",
"name": "Atlanta",
- "id": "6"
+ "division": "2",
+ "divisionName": "West"
+ },
+ {
+ "id": "7",
+ "name": "Denver",
+ "division": "2",
+ "divisionName": "West"
},
+ ]
+ }
+
+
+**GET /api/1.1/regions/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Region id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
{
- "name": "Beltway",
- "id": "1"
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
}
- ],
+ ]
+ }
+
+
+**PUT /api/1.1/regions/:id**
+ Update a region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Region id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +================+==========+==========================+
+ | ``name`` | yes | The name of the region |
+ +----------------+----------+--------------------------+
+ | ``division`` | yes | The division Id |
+ +----------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ "division": "4"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``division`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Region update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "myregion1",
+ "division": "4",
+ "divisionName": "mydivision1"
+ }
+ }
+|
+
+**POST /api/1.1/divisions/:division_name/regions**
+ Create Region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ division_name - The name of division to create new region into.
+
+ ** Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +===================+==========+================================================+
+ | ``division_name`` | yes | The name of division will create new region in |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+==========================================+
+ | ``name`` | yes | The name of the region |
+ +-------------------+----------+------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+===========================================+
+ | ``name`` | string | name of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``id`` | string | id of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionName`` | string | the division name the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionId`` | string | the id of division the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'divisionName': 'mydivision1',
+ 'divsionId': '4',
+ 'name': 'myregion1',
+ 'id': '19'
+ }
}
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v11/server.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v11/server.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v11/server.txt
index 9c437b8..61184f9 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v11/server.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v11/server.txt
@@ -24,7 +24,7 @@ Server
/api/1.1/servers
++++++++++++++++
-**GET /api/1.1/servers.json**
+**GET /api/1.1/servers**
Retrieves properties of CDN servers.
@@ -34,10 +34,170 @@ Server
**Request Query Parameters**
+ +--------------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +====================+==========+=============================================+
+ | ``dsId`` | no | Used to filter servers by delivery service. |
+ +--------------------+----------+---------------------------------------------+
+ | ``status`` | no | Used to filter servers by status. |
+ +--------------------+----------+---------------------------------------------+
+ | ``type`` | no | Used to filter servers by type. |
+ +--------------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/servers/:id**
+
+ Retrieves properties of a CDN server by server ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+-----------+----------+---------------------------------------------+
| Name | Required | Description |
+===========+==========+=============================================+
- | ``dsId`` | no | Used to filter servers by delivery service. |
+ | ``id`` | yes | Server id. |
+-----------+----------+---------------------------------------------+
**Response Properties**
@@ -47,10 +207,20 @@ Server
+====================+========+============================================================================================================+
| ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``domainName`` | string | The domain name part of the FQDN of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``hostName`` | string | The host name part of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``id`` | string | The server id (database row number). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
@@ -85,10 +255,18 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``rack`` | string | A string indicating rack location. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``routerHostName`` | string | The human readable name of the router. |
@@ -97,15 +275,15 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppId`` | string | Deprecated. |
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppPasswd`` | string | Deprecated. |
+ | ``updPending`` | bool | |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -114,7 +292,11 @@ Server
"response": [
{
"cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
"domainName": "chi.kabletown.net",
+ "guid": null,
"hostName": "atsec-chi-00",
"id": "19",
"iloIpAddress": "172.16.2.6",
@@ -133,27 +315,30 @@ Server
"mgmtIpAddress": "",
"mgmtIpGateway": "",
"mgmtIpNetmask": "",
+ "offlineReason": "N/A",
"physLocation": "plocation-chi-1",
+ "physLocationId": "9",
"profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
"rack": "RR 119.02",
"routerHostName": "rtr-chi.kabletown.net",
"routerPortName": "2",
"status": "ONLINE",
+ "statusId": "6",
"tcpPort": "80",
"httpsPort": "443",
"type": "EDGE",
- "xmppId": "atsec-chi-00-dummyxmpp",
- "xmppPasswd": "**********"
- },
- {
- ... more server data
+ "typeId": "3",
+ "updPending": false
}
]
}
|
-**GET /api/1.1/servers/summary.json**
+
+**GET /api/1.1/servers/summary**
Retrieves a count of CDN servers by type.
@@ -199,7 +384,7 @@ Server
|
-**GET /api/1.1/servers/hostname/:name/details.json**
+**GET /api/1.1/servers/hostname/:name/details**
Retrieves the details of a server.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v11/status.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v11/status.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v11/status.txt
index 0f2b7e0..853f276 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v11/status.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v11/status.txt
@@ -24,9 +24,9 @@ Status
/api/1.1/statuses
+++++++++++++++++
-**GET /api/1.1/statuses.json**
+**GET /api/1.1/statuses**
- Retrieves a list of the server status codes available. May be useful when the status is retrieved from other APIs as a number and not a string.
+ Retrieves a list of the server status codes available.
Authentication Required: Yes
@@ -37,49 +37,92 @@ Status
+-----------------+--------+--------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=================+========+================================================================================+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+-----------------+--------+--------------------------------------------------------------------------------+
| ``name`` | string | The string equivalent of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
- | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
- +-----------------+--------+--------------------------------------------------------------------------------+
| ``description`` | string | A short description of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"id": "4",
"name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"lastUpdated": "2013-02-13 16:34:29"
},
{
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "CCR_IGNORE",
"id": "5",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"
+ "name": "CCR_IGNORE",
+ "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
"id": "1",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "OFFLINE"
+ "name": "OFFLINE",
+ "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "2",
+ "name": "ONLINE",
"description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "ONLINE"
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "3",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
"name": "REPORTED",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
+
+**GET /api/1.1/statuses/:id**
+
+ Retrieves a server status by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Status id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"lastUpdated": "2013-02-13 16:34:29"
}
- ],
+ ]
}
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v11/type.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v11/type.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v11/type.txt
index c2d52d6..2430b97 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v11/type.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v11/type.txt
@@ -24,46 +24,54 @@ Types
/api/1.1/types
++++++++++++++
-**GET /api/1.1/types.json**
+**GET /api/1.1/types**
Authentication Required: Yes
Role(s) Required: None
+ **Request Query Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``useInTable`` | no | Filter types by the table in which they apply |
+ +----------------+----------+----------------------------------------------------+
+
**Response Properties**
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
+ |``id`` | string | |
+----------------------+--------+------------------------------------------------+
|``name`` | string | |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
|``description`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "lastUpdated": "2013-10-23 15:28:31",
- "useInTable": "staticdnsentry",
- "name": "AAAA_RECORD",
"id": "22",
- "description": "Static DNS AAAA entry"
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
}
- ],
+ ]
}
|
-**GET /api/1.1/types/trimmed.json**
+**GET /api/1.1/types/trimmed**
Authentication Required: Yes
@@ -96,3 +104,49 @@ Types
],
}
+**GET /api/1.1/types/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``id`` | yes | Type ID. |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v11/user.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v11/user.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v11/user.txt
index 2339d10..5b06ccc 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v11/user.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v11/user.txt
@@ -24,7 +24,7 @@ Users
/api/1.1/users
++++++++++++++
-**GET /api/1.1/users.json**
+**GET /api/1.1/users**
Retrieves all users.
@@ -37,70 +37,177 @@ Users
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``email`` | string | |
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+----------------------+--------+------------------------------------------------+
|``city`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
|``id`` | hash | |
+----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
|``phoneNumber`` | string | |
+----------------------+--------+------------------------------------------------+
- |``company`` | string | |
+ |``postalCode`` | string | |
+----------------------+--------+------------------------------------------------+
- |``country`` | string | |
+ |``publicSshKey`` | string | |
+----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
+ |``registrationSent`` | string | |
+----------------------+--------+------------------------------------------------+
- |``localUser`` | string | |
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+----------------------+--------+------------------------------------------------+
|``uid`` | string | |
+----------------------+--------+------------------------------------------------+
|``username`` | string | |
+----------------------+--------+------------------------------------------------+
- |``rolename`` | string | |
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/users/:id**
+
+ Retrieves user by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | User id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+----------------------+--------+------------------------------------------------+
- |``newUser`` | string | |
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+----------------------+--------+------------------------------------------------+
|``addressLine2`` | string | |
+----------------------+--------+------------------------------------------------+
- |``role`` | string | |
+ |``city`` | string | |
+----------------------+--------+------------------------------------------------+
- |``addressLine1`` | string | |
+ |``company`` | string | |
+----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+----------------------+--------+------------------------------------------------+
|``gid`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
-
- [
- {
- "email": "email@email.com",
- "city": "",
- "id": "54",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "Bob Simpson",
- "localUser": false,
- "uid": "0",
- "stateOrProvince": "",
- "username": "bsimpson",
- "rolename": "portal",
- "newUser": true,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "postalCode": "",
- "gid": "0"
- }
- ]
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ }
+ ]
+ }
|
-**GET /api/1.1/user/current.json**
+
+**GET /api/1.1/user/current**
Retrieves the profile for the authenticated user.
[08/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/cdn.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/cdn.html b/docs/latest/development/traffic_ops_api/v12/cdn.html
index 3802620..f1ab42c 100644
--- a/docs/latest/development/traffic_ops_api/v12/cdn.html
+++ b/docs/latest/development/traffic_ops_api/v12/cdn.html
@@ -190,16 +190,16 @@
<span id="to-api-v12-cdn"></span><h1>CDN<a class="headerlink" href="#cdn" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-cdns">
<span id="to-api-v12-cdn-route"></span><h2>/api/1.2/cdns<a class="headerlink" href="#api-1-2-cdns" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns.json</strong></p>
+<p><strong>GET /api/1.2/cdns</strong></p>
<blockquote>
<div><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="24%" />
+<col width="25%" />
<col width="11%" />
-<col width="65%" />
+<col width="64%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -208,22 +208,38 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>CDN name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>int</td>
-<td>CDN id.</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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-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">"name"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="mi">1</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">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">true</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>
@@ -233,16 +249,36 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/name/:name.json</strong></p>
+<p><strong>GET /api/1.2/cdns/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>CDN id.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="24%" />
+<col width="25%" />
<col width="11%" />
-<col width="65%" />
+<col width="64%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -251,22 +287,105 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>CDN name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>int</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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">"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">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/name/:name</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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>CDN name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</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>CDN id.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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-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">"name"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="mi">1</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">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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>
@@ -308,9 +427,9 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"cdn_test"</span><span class="p">,</span>
- <span class="s">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+<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">"cdn_test"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -359,19 +478,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response":{
- "name": "cdn_test",
- "id": 3
- "dnssecEnabled": 0
- },
- "alerts":[
- {
- "level": "success",
- "text": "cdn was created."
- }
- ]
-}
+<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="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">3</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</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">"cdn was created."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -430,9 +549,9 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"cdn_test2"</span><span class="p">,</span>
- <span class="s">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+<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">"cdn_test2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -481,19 +600,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response":{
- "name": "cdn_test2",
- "id": 3
- "dnssecEnabled": 0
- },
- "alerts":[
- {
- "level": "success",
- "text": "cdn was updated."
- }
- ]
-}
+<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="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test2"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">3</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</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">"cdn was updated."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -554,11 +673,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"cdn was deleted."</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">"cdn was deleted."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -571,7 +690,7 @@
</div>
<div class="section" id="health">
<h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">�</a></h2>
-<p id="to-api-v12-cdn-health-route"><strong>GET /api/1.2/cdns/health.json</strong></p>
+<p id="to-api-v12-cdn-health-route"><strong>GET /api/1.2/cdns/health</strong></p>
<blockquote>
<div><p>Retrieves the health of all locations (cache groups) for all CDNs.</p>
<p>Authentication Required: Yes</p>
@@ -618,20 +737,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -642,7 +761,7 @@ group.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/:name/health.json</strong></p>
+<p><strong>GET /api/1.2/cdns/:name/health</strong></p>
<blockquote>
<div><p>Retrieves the health of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -711,20 +830,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -735,7 +854,7 @@ group.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/usage/overview.json</strong></p>
+<p><strong>GET /api/1.2/cdns/usage/overview</strong></p>
<blockquote>
<div><p>Retrieves the high-level CDN usage metrics.</p>
<p>Authentication Required: Yes</p>
@@ -769,11 +888,11 @@ group.</td>
</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">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
- <span class="s">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
- <span class="s">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</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">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
+ <span class="s2">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
+ <span class="s2">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -782,7 +901,7 @@ group.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/capacity.json</strong></p>
+<p><strong>GET /api/1.2/cdns/capacity</strong></p>
<blockquote>
<div><p>Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -820,12 +939,12 @@ group.</td>
</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -837,7 +956,7 @@ group.</td>
</div>
<div class="section" id="routing">
<span id="to-api-v12-cdn-routing"></span><h2>Routing<a class="headerlink" href="#routing" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/routing.json</strong></p>
+<p><strong>GET /api/1.2/cdns/routing</strong></p>
<blockquote>
<div><p>Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -883,14 +1002,14 @@ group.</td>
</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -902,7 +1021,7 @@ group.</td>
</div>
<div class="section" id="metrics">
<span id="to-api-v12-cdn-metrics"></span><h2>Metrics<a class="headerlink" href="#metrics" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end.json</strong></p>
+<p><strong>GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end</strong></p>
<blockquote>
<div><p>Retrieves edge metrics of one or all locations (cache groups).</p>
<p>Authentication Required: Yes</p>
@@ -1004,20 +1123,20 @@ group.</td>
</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">"stats"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
- <span class="s">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
+ <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
<span class="p">},</span>
- <span class="s">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
<span class="mi">1425135900000</span><span class="p">,</span>
<span class="mf">1668.03</span>
@@ -1027,7 +1146,7 @@ group.</td>
<span class="n">null</span>
<span class="p">]</span>
<span class="p">],</span>
- <span class="s">"label"</span><span class="p">:</span> <span class="s">"Origin TPS"</span>
+ <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"Origin TPS"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1040,7 +1159,7 @@ group.</td>
</div>
<div class="section" id="domains">
<span id="to-api-v12-cdn-domains"></span><h2>Domains<a class="headerlink" href="#domains" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/domains.json</strong></p>
+<p><strong>GET /api/1.2/cdns/domains</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -1081,21 +1200,21 @@ group.</td>
</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">"profileId"</span><span class="p">:</span> <span class="s">"5"</span><span class="p">,</span>
- <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"404"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_FOO"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for foo.domain.net"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"foo.domain.net"</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"404"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_FOO"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for foo.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"foo.domain.net"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
- <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"405"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_BAR"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for bar.domain.net"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"bar.domain.net"</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"405"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_BAR"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for bar.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"bar.domain.net"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1108,7 +1227,7 @@ group.</td>
</div>
<div class="section" id="topology">
<span id="to-api-v12-cdn-topology"></span><h2>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/:cdn_name/configs.json</strong></p>
+<p><strong>GET /api/1.2/cdns/:cdn_name/configs</strong></p>
<blockquote>
<div><p>Retrieves CDN config information.</p>
<p>Authentication Required: Yes</p>
@@ -1165,14 +1284,14 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/:name/configs/monitoring.json</strong></p>
+<p><strong>GET /api/1.2/cdns/:name/configs/monitoring</strong></p>
<blockquote>
<div><p>Retrieves CDN monitoring information.</p>
<p>Authentication Required: Yes</p>
@@ -1427,14 +1546,14 @@ profiles.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/:name/configs/routing.json</strong></p>
+<p><strong>GET /api/1.2/cdns/:name/configs/routing</strong></p>
<blockquote>
<div><p>Retrieves CDN routing information.</p>
<p>Authentication Required: Yes</p>
@@ -1842,7 +1961,7 @@ services.</td>
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
</pre></div>
</div>
<div class="line-block">
@@ -1851,7 +1970,7 @@ services.</td>
</div>
<div class="section" id="dnssec-keys">
<span id="to-api-v12-cdn-dnsseckeys"></span><h2>DNSSEC Keys<a class="headerlink" href="#dnssec-keys" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/name/:name/dnsseckeys.json</strong></p>
+<p><strong>GET /api/1.2/cdns/name/:name/dnsseckeys</strong></p>
<blockquote>
<div><p>Gets a list of dnsseckeys for a CDN and all associated Delivery Services.</p>
<p>Authentication Required: Yes</p>
@@ -1941,58 +2060,58 @@ services.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": {
- "cdn1": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "foo.kabletown.com."
- },
- "ksk": {
- "name": "foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750",
- "ttl": "60",
- dsRecord: {
- "algorithm": "5",
- "digestType": "2",
- "digest": "abc123def456"
- }
- }
- },
- "ds-01": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "ds-01.foo.kabletown.com."
- },
- "ksk": {
- "name": "ds-01.foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750"
- }
- },
- ... repeated for each ds in the cdn
- },
-}
+<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">"cdn1"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="n">dsRecord</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"algorithm"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"digestType"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"digest"</span><span class="p">:</span> <span class="s2">"abc123def456"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s2">"ds-01"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="o">...</span> <span class="n">repeated</span> <span class="k">for</span> <span class="n">each</span> <span class="n">ds</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">cdn</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/cdns/name/:name/dnsseckeys/delete.json</strong></p>
+<p><strong>GET /api/1.2/cdns/name/:name/dnsseckeys/delete</strong></p>
<blockquote>
<div><p>Delete dnssec keys for a cdn and all associated delivery services.</p>
<p>Authentication Required: Yes</p>
@@ -2038,8 +2157,8 @@ services.</td>
</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="s">"Successfully deleted dnssec keys for <cdn>"</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="s2">"Successfully deleted dnssec keys for <cdn>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -2089,13 +2208,13 @@ services.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "key": "cdn1",
- "name" "ott.kabletown.com",
- "ttl": "60",
- "kskExpirationDays": "365",
- "zskExpirationDays": "90"
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"cdn1"</span><span class="p">,</span>
+ <span class="s2">"name"</span> <span class="s2">"ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"kskExpirationDays"</span><span class="p">:</span> <span class="s2">"365"</span><span class="p">,</span>
+ <span class="s2">"zskExpirationDays"</span><span class="p">:</span> <span class="s2">"90"</span>
+<span class="p">}</span>
</pre></div>
</div>
<p><strong>Response Properties</strong></p>
@@ -2123,8 +2242,8 @@ services.</td>
</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="s">"Successfully created dnssec keys for cdn1"</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="s2">"Successfully created dnssec keys for cdn1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -2132,7 +2251,7 @@ services.</td>
</div>
<div class="section" id="ssl-keys">
<span id="to-api-v12-cdn-sslkeys"></span><h2>SSL Keys<a class="headerlink" href="#ssl-keys" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/name/:name/sslkeys.json</strong></p>
+<p><strong>GET /api/1.2/cdns/name/:name/sslkeys</strong></p>
<blockquote>
<div><p>Returns ssl certificates for all Delivery Services that are a part of the CDN.</p>
<p>Authentication Required: Yes</p>
@@ -2190,20 +2309,20 @@ services.</td>
</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">"deliveryservice"</span><span class="p">:</span> <span class="s">"ds1"</span><span class="p">,</span>
- <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"base64encodedcrt1"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"base64encodedkey1"</span>
+ <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"ds1"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"base64encodedcrt1"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"base64encodedkey1"</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">"ds2"</span><span class="p">,</span>
- <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"base64encodedcrt2"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"base64encodedkey2"</span>
+ <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"ds2"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"base64encodedcrt2"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"base64encodedkey2"</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/changelog.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/changelog.html b/docs/latest/development/traffic_ops_api/v12/changelog.html
index 7d49da5..efbe137 100644
--- a/docs/latest/development/traffic_ops_api/v12/changelog.html
+++ b/docs/latest/development/traffic_ops_api/v12/changelog.html
@@ -235,23 +235,23 @@
</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">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
<span class="p">},</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -326,23 +326,23 @@
</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">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -377,9 +377,9 @@
</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">"newLogcount"</span><span class="p">:</span> <span class="mi">0</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">"newLogcount"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
[48/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/asn.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/asn.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/asn.txt
index 4cdbd61..fb45a07 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/asn.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/asn.txt
@@ -25,7 +25,7 @@ ASN
/api/1.2/asns
+++++++++++++
-**GET /api/1.2/asns.json**
+**GET /api/1.2/asns**
Authentication Required: Yes
@@ -36,13 +36,15 @@ ASN
+------------------+--------+-------------------------------------------------------------------------+
| Parameter | Type | Description |
+==================+========+=========================================================================+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+------------------+--------+-------------------------------------------------------------------------+
- | ``id`` | string | Local unique identifier for the ASN |
+ | ``id`` | string | Local unique identifier for the ASN |
+------------------+--------+-------------------------------------------------------------------------+
- | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+ | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+------------------+--------+-------------------------------------------------------------------------+
- | ``cachegroup`` | string | Related cachegroup name |
+ | ``cachegroup`` | string | Related cachegroup name |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | Related cachegroup id |
+------------------+--------+-------------------------------------------------------------------------+
**Response Example** ::
@@ -53,15 +55,139 @@ ASN
"lastUpdated": "2012-09-17 21:41:22",
"id": "27",
"asn": "7015",
- "cachegroup": "us-ma-woburn"
+ "cachegroup": "us-ma-woburn",
+ "cachegroupId": "27",
},
{
"lastUpdated": "2012-09-17 21:41:22",
"id": "28",
"asn": "7016",
- "cachegroup": "us-pa-pittsburgh"
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "13"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/asns/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | ASN id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``id`` | string | Local unique identifier for the ASN |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroup`` | string | Related cachegroup name |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | Related cachegroup id |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "7016",
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "13"
}
]
}
|
+
+**PUT /api/1.2/asns/{:id}**
+
+ Allows user to edit an ASN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | ASN id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``asn`` | string | ASN |
+ +-------------------+--------+-------------------------------------------------+
+ | ``cachegroupId`` | string | The cachegroup the ASN belongs to |
+ +-------------------+--------+-------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "asn": "99",
+ "cachegroupId": "177"
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+=================================================+
+ | ``response`` | hash | The details of the update, if success. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | CDN name. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>id`` | int | CDN id. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "99",
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "177"
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was updated."
+ }
+ ]
+ }
+
+|
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/cachegroup.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/cachegroup.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/cachegroup.txt
index 08935d6..5e6dc06 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/cachegroup.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/cachegroup.txt
@@ -24,7 +24,7 @@ Cache Group
/api/1.2/cachegroups
++++++++++++++++++++
-**GET /api/1.2/cachegroups.json**
+**GET /api/1.1/cachegroups**
Authentication Required: Yes
@@ -32,67 +32,77 @@ Cache Group
**Response Properties**
- +------------------------+--------+--------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +========================+========+==========================================================================+
- | ``longitude`` | string | Longitude for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupId`` | string | Identifier that refers to the 'id' field of different Cache Group entry. |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this entry was last updated |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``typeName`` | string | The type name of Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``name`` | string | The name of the Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``latitude`` | string | Latitude for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``id`` | string | Local unique identifier for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``shortName`` | string | Abbreviation of the Cache Group Name |
- +------------------------+--------+--------------------------------------------------------------------------+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "longitude": "0",
- "parentCachegroupId": null,
+ "id": "21",
"lastUpdated": "2012-09-25 20:27:28",
- "typeName": "MID_LOC",
+ "latitude": "0",
+ "longitude": "0",
"name": "dc-chicago",
+ "parentCachegroupId": null,
"parentCachegroupName": null,
- "typeId": "4",
- "latitude": "0",
- "id": "21",
- "shortName": "dcchi"
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
},
{
+ "id": "22",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
"longitude": "0",
+ "name": "dc-chicago-1",
"parentCachegroupId": null,
- "lastUpdated": "2012-09-25 20:32:03",
- "typeName": "MID_LOC",
- "name": "dc-cmc",
"parentCachegroupName": null,
- "typeId": "4",
- "latitude": "0",
- "id": "22",
- "shortName": "dccmc"
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
}
],
}
|
-**GET /api/1.2/cachegroups/trimmed.json**
+**GET /api/1.2/cachegroups/trimmed**
Authentication Required: Yes
- Role(s) Required Required: None
-
+ Role(s) Required: None
+
**Response Properties**
+----------------------+--------+------------------------------------------------+
@@ -116,7 +126,67 @@ Cache Group
|
-**GET /api/1.2/cachegroup/:parameter_id/parameter.json**
+**GET /api/1.2/cachegroups/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ }
+ ],
+ }
+
+|
+
+
+**GET /api/1.2/cachegroup/:parameter_id/parameter**
Authentication Required: Yes
@@ -161,7 +231,7 @@ Cache Group
|
-**GET /api/1.2/cachegroupparameters.json**
+**GET /api/1.2/cachegroupparameters**
Authentication Required: Yes
@@ -207,7 +277,7 @@ Cache Group
|
-**GET /api/1.2/cachegroups/:parameter_id/parameter/available.json**
+**GET /api/1.2/cachegroups/:parameter_id/parameter/available**
Authentication Required: Yes
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/cdn.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/cdn.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/cdn.txt
index 855d2d2..9a4daac 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/cdn.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/cdn.txt
@@ -24,7 +24,7 @@ CDN
/api/1.2/cdns
+++++++++++++
-**GET /api/1.2/cdns.json**
+**GET /api/1.2/cdns**
Authentication Required: Yes
@@ -32,50 +32,119 @@ CDN
**Response Properties**
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``name`` | string | CDN name. |
- +------------------+--------+-------------------------------------------------+
- | ``id`` | int | CDN id. |
- +------------------+--------+-------------------------------------------------+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
**Response Example** ::
{
"response": [
{
+ "id": "1"
"name": "over-the-top",
- "id": 1
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": true,
+ "lastUpdated": "2014-10-02 08:22:43"
}
]
}
|
-**GET /api/1.2/cdns/name/:name.json**
+**GET /api/1.2/cdns/:id**
Authentication Required: Yes
Role(s) Required: None
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | CDN id. |
+ +-----------+----------+---------------------------------------------+
+
**Response Properties**
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``name`` | string | CDN name. |
- +------------------+--------+-------------------------------------------------+
- | ``id`` | int | CDN id. |
- +------------------+--------+-------------------------------------------------+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "name": "over-the-top",
- "id": 1
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/cdns/name/:name**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``name`` | yes | CDN name. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
}
]
}
@@ -268,7 +337,7 @@ Health
.. _to-api-v12-cdn-health-route:
-**GET /api/1.2/cdns/health.json**
+**GET /api/1.2/cdns/health**
Retrieves the health of all locations (cache groups) for all CDNs.
@@ -318,7 +387,7 @@ Health
|
-**GET /api/1.2/cdns/:name/health.json**
+**GET /api/1.2/cdns/:name/health**
Retrieves the health of all locations (cache groups) for a given CDN.
@@ -378,7 +447,7 @@ Health
|
-**GET /api/1.2/cdns/usage/overview.json**
+**GET /api/1.2/cdns/usage/overview**
Retrieves the high-level CDN usage metrics.
@@ -410,7 +479,7 @@ Health
|
-**GET /api/1.2/cdns/capacity.json**
+**GET /api/1.2/cdns/capacity**
Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.
@@ -450,7 +519,7 @@ Health
Routing
+++++++
-**GET /api/1.2/cdns/routing.json**
+**GET /api/1.2/cdns/routing**
Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.
@@ -496,7 +565,7 @@ Routing
Metrics
+++++++
-**GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end.json**
+**GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end**
Retrieves edge metrics of one or all locations (cache groups).
@@ -585,7 +654,7 @@ Metrics
Domains
+++++++
-**GET /api/1.2/cdns/domains.json**
+**GET /api/1.2/cdns/domains**
Authentication Required: Yes
@@ -635,7 +704,7 @@ Domains
Topology
++++++++
-**GET /api/1.2/cdns/:cdn_name/configs.json**
+**GET /api/1.2/cdns/:cdn_name/configs**
Retrieves CDN config information.
@@ -669,7 +738,7 @@ Topology
|
-**GET /api/1.2/cdns/:name/configs/monitoring.json**
+**GET /api/1.2/cdns/:name/configs/monitoring**
Retrieves CDN monitoring information.
@@ -807,7 +876,7 @@ Topology
|
-**GET /api/1.2/cdns/:name/configs/routing.json**
+**GET /api/1.2/cdns/:name/configs/routing**
Retrieves CDN routing information.
@@ -1025,7 +1094,7 @@ Topology
DNSSEC Keys
+++++++++++
-**GET /api/1.2/cdns/name/:name/dnsseckeys.json**
+**GET /api/1.2/cdns/name/:name/dnsseckeys**
Gets a list of dnsseckeys for a CDN and all associated Delivery Services.
@@ -1122,7 +1191,7 @@ DNSSEC Keys
|
-**GET /api/1.2/cdns/name/:name/dnsseckeys/delete.json**
+**GET /api/1.2/cdns/name/:name/dnsseckeys/delete**
Delete dnssec keys for a cdn and all associated delivery services.
@@ -1211,7 +1280,7 @@ DNSSEC Keys
SSL Keys
+++++++++++
-**GET /api/1.2/cdns/name/:name/sslkeys.json**
+**GET /api/1.2/cdns/name/:name/sslkeys**
Returns ssl certificates for all Delivery Services that are a part of the CDN.
[31/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/phys_location.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/phys_location.html b/docs/1.7.0/development/traffic_ops_api/v12/phys_location.html
index 4765744..bd4f778 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/phys_location.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/phys_location.html
@@ -190,7 +190,7 @@
<span id="to-api-v12-phys-loc"></span><h1>Physical Location<a class="headerlink" href="#physical-location" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-phys-locations">
<span id="to-api-v12-phys-loc-route"></span><h2>/api/1.2/phys_locations<a class="headerlink" href="#api-1-2-phys-locations" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/phys_locations.json</strong></p>
+<p><strong>GET /api/1.2/phys_locations</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,47 +208,47 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</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>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<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">email</span></code></td>
+<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">city</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</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>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -256,40 +256,52 @@
<td>string</td>
<td> </td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
</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">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
- <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"region"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"poc"</span><span class="p">:</span> <span class="s">"John Doe"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(321) 555-1111"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"IL"</span><span class="p">,</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"john.doe@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"60636"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 4th Street"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"chicago"</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -322,13 +334,348 @@
</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">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Ashburn"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Ashburn"</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/phys_locations/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Physical location ID.</td>
+</tr>
+</tbody>
+</table>
+<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">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</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">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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>PUT /api/1.2/phys_locations/:id</strong></dt>
+<dd><p class="first">Update a physical location</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>Physical location id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</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">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">address</span></code></td>
+<td>yes</td>
+<td>Physical location address.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td>Physical location city.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td>Physical location comments.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>no</td>
+<td>Physical location email.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>Physical location name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td>Physical location phone.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Physical location point of contact.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>no</td>
+<td>Physical location region ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>Physical location short name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td>Physical location state.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td>Physical location zip.</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">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</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">"Physical location 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="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -421,14 +768,14 @@
</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">"my physical location1"</span><span class="p">,</span>
- <span class="s">"shortName"</span> <span class="p">:</span> <span class="s">"myphylocation1"</span><span class="p">,</span>
- <span class="s">"address"</span> <span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"city"</span> <span class="p">:</span> <span class="s">"Shanghai"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"SH"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"200000"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">"this is physical location1"</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">"my physical location1"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span>
+ <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"this is physical location1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -507,23 +854,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": {
- 'shortName': 'myphylocati',
- 'regionName': 'myregion1',
- 'name': 'my physical location1',
- 'poc': '',
- 'phone': '',
- 'comments': 'this is physical location1',
- 'state': 'SH',
- 'email': '',
- 'zip': '20000',
- 'region_id': '20',
- 'city': 'Shanghai',
- 'address': '',
- 'id': '200'
- }
-}
+<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">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span>
+ <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span>
+ <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span>
+ <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span>
+ <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span>
+ <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span>
+ <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span>
+ <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/profile.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/profile.html b/docs/1.7.0/development/traffic_ops_api/v12/profile.html
index c85ecaf..9e7db37 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/profile.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/profile.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="InfluxDB" href="influxdb.html"/>
+ <link rel="next" title="Profile parameters" href="profile_parameter.html"/>
<link rel="prev" title="Physical Location" href="phys_location.html"/>
@@ -177,7 +177,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="profile_parameter.html" class="btn btn-neutral float-right" title="Profile parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -190,11 +190,31 @@
<span id="to-api-v12-profile"></span><h1>Profiles<a class="headerlink" href="#profiles" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-profiles">
<span id="to-api-v12-profiles-route"></span><h2>/api/1.2/profiles<a class="headerlink" href="#api-1-2-profiles" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/profiles.json</strong></p>
+<p><strong>GET /api/1.2/profiles</strong></p>
<blockquote>
<div><blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="13%" />
+<col width="68%" />
+</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">param</span></code></td>
+<td>no</td>
+<td>Used to filter profiles by parameter.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -229,13 +249,13 @@
</table>
</div></blockquote>
<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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -245,7 +265,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/profiles/trimmed.json</strong></p>
+<p><strong>GET /api/1.2/profiles/trimmed</strong></p>
<blockquote>
<div><blockquote>
<div><p>Authentication Required: Yes</p>
@@ -272,10 +292,85 @@
</table>
</div></blockquote>
<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="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</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</strong></p>
+<blockquote>
+<div><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="22%" />
+<col width="16%" />
+<col width="62%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>The ID of the profile.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="10%" />
+<col width="68%" />
+</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">lastUpdated</span></code></td>
+<td>array</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">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<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="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -319,9 +414,9 @@
</div></blockquote>
</div></blockquote>
<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">"CCR_COPY"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</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">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -362,12 +457,12 @@
</table>
</div></blockquote>
<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">"id"</span><span class="p">:</span> <span class="s">"66"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -447,14 +542,14 @@
</div></blockquote>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="last 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="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="s">"id"</span><span class="p">:</span> <span class="s">"66"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span>
- <span class="s">"profileCopyFrom"</span><span class="p">:</span> <span class="s">"CCR1"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span>
- <span class="s">"idCopyFrom"</span><span class="p">:</span> <span class="s">"3"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s2">"profileCopyFrom"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
+ <span class="s2">"idCopyFrom"</span><span class="p">:</span> <span class="s2">"3"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -465,6 +560,182 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>PUT /api/1.2/profiles/{:id}</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Allows user to edit a profile.</p>
+<blockquote>
+<div><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="22%" />
+<col width="13%" />
+<col width="65%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</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 new name for the profile.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>yes</td>
+<td>The new description for the profile.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span>{
+ "name": "CCR_UPDATE",
+ "description": "CCR_UPDATE description"
+}
+
+ **Response Properties**
+
+ +------------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+==================================+
+ | ``response`` | | The updated profile info. |
+ +------------------+--------+----------------------------------+
+ | ``>id`` | string | Profile id. |
+ +------------------+--------+----------------------------------+
+ | ``>name`` | string | Profile name. |
+ +------------------+--------+----------------------------------+
+ | ``>description`` | string | Profile description. |
+ +------------------+--------+----------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+--------+----------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +------------------+--------+----------------------------------+
+</pre></div>
+</div>
+<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="s2">"id"</span><span class="p">:</span> <span class="s2">"219"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_UPDATE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_UPDATE description"</span>
+ <span class="p">}</span>
+ <span class="s2">"alerts"</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">"Profile was updated: 219"</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>DELETE /api/1.2/profiles/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to delete a profile.</p>
+<blockquote>
+<div><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="31%" />
+<col width="18%" />
+<col width="51%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+</tbody>
+</table>
+<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>
+</div></blockquote>
+<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">"Profile was deleted."</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>
</div>
</div>
@@ -474,7 +745,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="profile_parameter.html" class="btn btn-neutral float-right" title="Profile parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a>
[10/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/system.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/system.html b/docs/latest/development/traffic_ops_api/v11/system.html
index aabcf08..340a58a 100644
--- a/docs/latest/development/traffic_ops_api/v11/system.html
+++ b/docs/latest/development/traffic_ops_api/v11/system.html
@@ -252,16 +252,16 @@ set this parameter on a production system.</td>
</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">"parameters"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"tm.toolname"</span><span class="p">:</span> <span class="s">"Traffic Ops"</span><span class="p">,</span>
- <span class="s">"tm.infourl"</span><span class="p">:</span> <span class="s">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
- <span class="s">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s">"tm.logourl"</span><span class="p">:</span> <span class="s">"\/images\/tc_logo.png"</span><span class="p">,</span>
- <span class="s">"tm.url"</span><span class="p">:</span> <span class="s">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
- <span class="s">"tm.instance_name"</span><span class="p">:</span> <span class="s">"Kabletown CDN"</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">"parameters"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"tm.toolname"</span><span class="p">:</span> <span class="s2">"Traffic Ops"</span><span class="p">,</span>
+ <span class="s2">"tm.infourl"</span><span class="p">:</span> <span class="s2">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
+ <span class="s2">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"tm.logourl"</span><span class="p">:</span> <span class="s2">"\/images\/tc_logo.png"</span><span class="p">,</span>
+ <span class="s2">"tm.url"</span><span class="p">:</span> <span class="s2">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
+ <span class="s2">"tm.instance_name"</span><span class="p">:</span> <span class="s2">"Kabletown CDN"</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/v11/to_extension.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/to_extension.html b/docs/latest/development/traffic_ops_api/v11/to_extension.html
index c3ce3a9..b9b6d61 100644
--- a/docs/latest/development/traffic_ops_api/v11/to_extension.html
+++ b/docs/latest/development/traffic_ops_api/v11/to_extension.html
@@ -251,34 +251,34 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- script_file: "ping",
- version: "1.0.0",
- name: "ILO_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
- isactive: "1",
- id: "1",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "ILO"
- },
- {
- script_file: "ping",
- version: "1.0.0",
- name: "10G_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
- isactive: "1",
- id: "2",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "10G"
- }
- ],
-}
+<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="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ilo_ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">9</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&
quot;</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"10G_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&quo
t;</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"10G"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
<div class="line-block">
@@ -342,17 +342,17 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "name": "ILO_PING",
- "version": "1.0.0",
- "info_url": "http://foo.com/bar.html",
- "script_file": "ping",
- "isactive": "1",
- "additional_config_json": "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}",
- "description": null,
- "servercheck_short_name": "ILO"
- "type": "CHECK_EXTENSION_BOOL",
-}
+<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">"ILO_PING"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="s2">"info_url"</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="s2">"script_file"</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="s2">"isactive"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"additional_config_json"</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -389,11 +389,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Check Extension loaded."</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">"Check Extension loaded."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -457,11 +457,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Extension deleted."</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">"Extension deleted."</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/v11/type.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/type.html b/docs/latest/development/traffic_ops_api/v11/type.html
index 8ffc8c4..1c527fe 100644
--- a/docs/latest/development/traffic_ops_api/v11/type.html
+++ b/docs/latest/development/traffic_ops_api/v11/type.html
@@ -190,10 +190,30 @@
<span id="to-api-v11-type"></span><h1>Types<a class="headerlink" href="#types" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-types">
<span id="to-api-v11-types-route"></span><h2>/api/1.1/types<a class="headerlink" href="#api-1-1-types" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/types.json</strong></p>
+<p><strong>GET /api/1.1/types</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="67%" />
+</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">useInTable</span></code></td>
+<td>no</td>
+<td>Filter types by the table in which they apply</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -208,39 +228,39 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</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>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</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>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<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-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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-10-23 15:28:31"</span><span class="p">,</span>
- <span class="s">"useInTable"</span><span class="p">:</span> <span class="s">"staticdnsentry"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Static DNS AAAA entry"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -248,7 +268,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/types/trimmed.json</strong></p>
+<p><strong>GET /api/1.1/types/trimmed</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -273,25 +293,103 @@
</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">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"ACTIVE_DIRECTORY"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ACTIVE_DIRECTORY"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"A_RECORD"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"A_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
+<p><strong>GET /api/1.1/types/:id</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="21%" />
+<col width="13%" />
+<col width="67%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Type ID.</td>
+</tr>
+</tbody>
+</table>
+<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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</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">"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">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</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>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/user.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/user.html b/docs/latest/development/traffic_ops_api/v11/user.html
index 63fe7ac..3b51cb1 100644
--- a/docs/latest/development/traffic_ops_api/v11/user.html
+++ b/docs/latest/development/traffic_ops_api/v11/user.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-users"></span><h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-users">
<span id="to-api-v11-users-route"></span><h2>/api/1.1/users<a class="headerlink" href="#api-1-1-users" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/users.json</strong></p>
+<p><strong>GET /api/1.1/users</strong></p>
<blockquote>
<div><p>Retrieves all users.</p>
<p>Authentication Required: Yes</p>
@@ -209,11 +209,35 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -221,23 +245,39 @@
<td>hash</td>
<td> </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">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">localUser</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -249,15 +289,140 @@
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rolename</span></code></td>
+</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">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">users</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.1/users/:id</strong></p>
+<blockquote>
+<div><p>Retrieves user by ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>User id.</td>
+</tr>
+</tbody>
+</table>
+<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">addressLine1</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>hash</td>
+<td> </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">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -265,50 +430,58 @@
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td>
<td>string</td>
<td> </td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">[</span>
- <span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"54"</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Bob Simpson"</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"bsimpson"</span><span class="p">,</span>
- <span class="s">"rolename"</span><span class="p">:</span> <span class="s">"portal"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</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="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</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.1/user/current.json</strong></p>
+<p><strong>GET /api/1.1/user/current</strong></p>
<blockquote>
<div><p>Retrieves the profile for the authenticated user.</p>
<p>Authentication Required: Yes</p>
@@ -398,25 +571,25 @@
</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">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"50"</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Callahan"</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</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">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"50"</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Callahan"</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -515,25 +688,25 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -571,11 +744,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"UserProfile was successfully updated."</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">"UserProfile was successfully updated."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -687,23 +860,23 @@
</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">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"keyword"</span><span class="p">:</span> <span class="s">"PURGE"</span><span class="p">,</span>
- <span class="s">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"assetUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"assetType"</span><span class="p">:</span> <span class="s">"file"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"PENDING"</span><span class="p">,</span>
- <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
- <span class="s">"dsXmlId"</span><span class="p">:</span> <span class="s">"ds-xml-id"</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"peewee"</span><span class="p">,</span>
- <span class="s">"parameters"</span><span class="p">:</span> <span class="s">"TTL:56h"</span><span class="p">,</span>
- <span class="s">"enteredTime"</span><span class="p">:</span> <span class="s">"2015-01-21 18:00:16"</span><span class="p">,</span>
- <span class="s">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"agent"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-21 10:45:38"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span>
+ <span class="s2">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"assetType"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"PENDING"</span><span class="p">,</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"dsXmlId"</span><span class="p">:</span> <span class="s2">"ds-xml-id"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"peewee"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:56h"</span><span class="p">,</span>
+ <span class="s2">"enteredTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 18:00:16"</span><span class="p">,</span>
+ <span class="s2">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"agent"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 10:45:38"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -771,11 +944,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
- <span class="s">"regex"</span><span class="p">:</span> <span class="s">"/path/to/content.jpg"</span><span class="p">,</span>
- <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-27 11:08:37"</span><span class="p">,</span>
- <span class="s">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"regex"</span><span class="p">:</span> <span class="s2">"/path/to/content.jpg"</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-27 11:08:37"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -817,12 +990,12 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span>
+<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="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully created purge job for: ."</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">"Successfully created purge job for: ."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -862,9 +1035,9 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"u"</span><span class="p">:</span> <span class="s">"username"</span><span class="p">,</span>
- <span class="s">"p"</span><span class="p">:</span> <span class="s">"password"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"u"</span><span class="p">:</span> <span class="s2">"username"</span><span class="p">,</span>
+ <span class="s2">"p"</span><span class="p">:</span> <span class="s2">"password"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -906,11 +1079,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully logged in."</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">"Successfully logged in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -969,15 +1142,15 @@ unnecessary work.</td>
</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">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"90"</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"90"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img-secure"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"280"</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img-secure"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"280"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1013,8 +1186,8 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"t"</span><span class="p">:</span> <span class="s">"token-value"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"token-value"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1056,11 +1229,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"error"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Unauthorized, please log in."</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Unauthorized, please log in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1114,11 +1287,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"You are logged out."</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">"You are logged out."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1155,8 +1328,8 @@ password reset.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1204,11 +1377,11 @@ password reset.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully sent password reset to email 'email@email.com'"</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">"Successfully sent password reset to email 'email@email.com'"</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/asn.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/asn.html b/docs/latest/development/traffic_ops_api/v12/asn.html
index 2833b99..b9b732d 100644
--- a/docs/latest/development/traffic_ops_api/v12/asn.html
+++ b/docs/latest/development/traffic_ops_api/v12/asn.html
@@ -190,7 +190,7 @@
<span id="to-api-v12-asn"></span><h1>ASN<a class="headerlink" href="#asn" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-asns">
<span id="to-api-v12-asns-route"></span><h2>/api/1.2/asns<a class="headerlink" href="#api-1-2-asns" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/asns.json</strong></p>
+<p><strong>GET /api/1.2/asns</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,30 +208,44 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td colspan="3"><code class="docutils literal"><span class="pre">lastUpdated</span></code> | string | The Time / Date this server entry was last updated</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
</tr>
-<tr class="row-odd"><td colspan="3"><code class="docutils literal"><span class="pre">id</span></code> | string | Local unique identifier for the ASN</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the ASN</td>
</tr>
-<tr class="row-even"><td colspan="3"><code class="docutils literal"><span class="pre">asn</span></code> | string | Autonomous System Numbers per APNIC for identifying a service provider.</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">asn</span></code></td>
+<td>string</td>
+<td>Autonomous System Numbers per APNIC for identifying a service provider.</td>
</tr>
-<tr class="row-odd"><td colspan="3"><code class="docutils literal"><span class="pre">cachegroup</span></code> | string | Related cachegroup name</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>Related cachegroup name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>Related cachegroup id</td>
</tr>
</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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span>
- <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7015"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</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">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"28"</span><span class="p">,</span>
- <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7016"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-pa-pittsburgh"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -241,6 +255,206 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>GET /api/1.2/asns/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>ASN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="8%" />
+<col width="74%" />
+</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">lastUpdated</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">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the ASN</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">asn</span></code></td>
+<td>string</td>
+<td>Autonomous System Numbers per APNIC for identifying a service provider.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>Related cachegroup name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>Related cachegroup id</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">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</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>PUT /api/1.2/asns/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to edit an ASN.</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>ASN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</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">asn</span></code></td>
+<td>string</td>
+<td>ASN</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cachegroup the ASN belongs to</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">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</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">response</span></code></td>
+<td>hash</td>
+<td>The details of the update, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>id</span></code></td>
+<td>int</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>dnssecEnabled</span></code></td>
+<td>string</td>
+<td>Whether dnssec is enabled.</td>
+</tr>
+<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>
+</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="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</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">"cdn was updated."</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>
</div>
</div>
[26/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/searchindex.js
----------------------------------------------------------------------
diff --git a/docs/1.7.0/searchindex.js b/docs/1.7.0/searchindex.js
index 94864ed..4693886 100644
--- a/docs/1.7.0/searchindex.js
+++ b/docs/1.7.0/searchindex.js
@@ -1 +1 @@
-Search.setIndex({envversion:46,filenames:["admin/index","admin/quick_howto/dnssec","admin/quick_howto/federations","admin/quick_howto/index","admin/quick_howto/multi_site","admin/quick_howto/regionalgeo","admin/quick_howto/steering","admin/traffic_monitor","admin/traffic_ops_config","admin/traffic_ops_extensions","admin/traffic_ops_install","admin/traffic_ops_using","admin/traffic_portal","admin/traffic_router","admin/traffic_server","admin/traffic_stats","admin/traffic_vault","basics/cache_revalidation","basics/caching_proxies","basics/content_delivery_networks","basics/http_11","basics/index","development/index","development/traffic_monitor","development/traffic_monitor/traffic_monitor_api","development/traffic_ops","development/traffic_ops_api/routes","development/traffic_ops_api/v11/asn","development/traffic_ops_api/v11/cachegroup","development/traffic_ops_api/v11/cdn","development/traffic_ops_api/v11/changelog","development/traffic_ops_api/v11/deliveryservice","development/traf
fic_ops_api/v11/hwinfo","development/traffic_ops_api/v11/parameter","development/traffic_ops_api/v11/phys_location","development/traffic_ops_api/v11/profile","development/traffic_ops_api/v11/region","development/traffic_ops_api/v11/role","development/traffic_ops_api/v11/server","development/traffic_ops_api/v11/static_dns","development/traffic_ops_api/v11/status","development/traffic_ops_api/v11/system","development/traffic_ops_api/v11/to_extension","development/traffic_ops_api/v11/type","development/traffic_ops_api/v11/user","development/traffic_ops_api/v12/asn","development/traffic_ops_api/v12/cache_stats","development/traffic_ops_api/v12/cachegroup","development/traffic_ops_api/v12/cdn","development/traffic_ops_api/v12/changelog","development/traffic_ops_api/v12/deliveryservice","development/traffic_ops_api/v12/deliveryservice_stats","development/traffic_ops_api/v12/division","development/traffic_ops_api/v12/federation","development/traffic_ops_api/v12/hwinfo","development/traffic
_ops_api/v12/influxdb","development/traffic_ops_api/v12/parameter","development/traffic_ops_api/v12/phys_location","development/traffic_ops_api/v12/profile","development/traffic_ops_api/v12/region","development/traffic_ops_api/v12/role","development/traffic_ops_api/v12/server","development/traffic_ops_api/v12/static_dns","development/traffic_ops_api/v12/status","development/traffic_ops_api/v12/system","development/traffic_ops_api/v12/to_extension","development/traffic_ops_api/v12/topology","development/traffic_ops_api/v12/type","development/traffic_ops_api/v12/user","development/traffic_portal","development/traffic_router","development/traffic_router/traffic_router_api","development/traffic_server","development/traffic_stats","faq/administration","faq/development","faq/general","faq/index","glossary","index","overview/index","overview/introduction","overview/traffic_monitor","overview/traffic_ops","overview/traffic_portal","overview/traffic_router","overview/traffic_server","overvie
w/traffic_stats","overview/traffic_vault"],objects:{},objnames:{},objtypes:{},terms:{"00z":[46,51],"03m":10,"06b4f870d809d82a91433e92eae8320875c3e8b0":2,"08g":[],"0x10001":10,"10g":[9,11,25,38,42,61,65],"10g6":[9,11,25],"10g_ping":[42,65],"10gbp":8,"10t22":46,"11t11":51,"11t12":[46,51],"12m":[40,63],"12t12":[46,51],"17m":10,"1aa008f":[17,18],"1b08977e91f8f68b0ff5d5e5f6481c76ddfd0853":25,"1gb":8,"1min":15,"200mb":13,"20141222103718_extens":[10,25],"20150108100000_add_job_deliveryservic":[10,25],"20150205100000_cg_locat":[10,25],"20150209100000_cran_to_asn":[10,25],"20150210100000_ds_keyinfo":[10,25],"20150304100000_add_ip6_ds_rout":10,"20150310100000_add_bg_fetch":10,"20150316100000_move_hdr_rw":10,"24h":15,"25g":[],"2gb":13,"2xx":82,"32gb":10,"3rd":[29,31,34,48,50,57],"3xx":82,"4217a5":[38,61],"43c5d003453b96e38ad3eae54026d8e1b078a7fd":[],"46b":[],"4th":[34,57],"4xx":82,"50a3559482cc0":[17,18],"50aa00feadd":17,"567a":11,"567b":11,"56h":[44,68],"5gbp":8,"5thpercentil":[29,31,48],"606
641459177bc09":[],"73be":10,"8a5a61b91473bc785d4073fe711de8d2c63f02dd":25,"8d65":10,"8gb":[7,13],"95thpercentil":[29,31,48],"98thpercentil":[29,31,48],"__cache_ipv4__":11,"__hostname__":[33,56],"__return__":[4,11],"_before_":11,"_osvers":11,"boolean":[24,25,29,31,33,44,48,50,56,68],"byte":[11,25,82,87],"case":[],"class":[10,13,25,70,84],"default":[1,4,7,8,10,11,13,14,15,16,17,18,20,25,33,38,50,56,61,69,70,83,87],"export":[8,11,15,25,86],"final":[8,13],"float":[46,51],"function":[10,11,13,18,20,25,69,78,79,83,84,85,87],"import":[8,11,20,23,70,85,86],"int":[11,24,29,30,31,38,44,46,47,48,50,51,53,61,68],"long":[8,10,11,13,17,20,44,68],"new":[1,4,5,8,11,13,15,16,17,29,44,53,58,59,68,82,84],"null":[9,28,29,30,31,42,44,47,48,49,50,51,61,65,68],"public":[8,10,12,13,15,25,29,41,48,64,88],"return":[11,13,16,24,25,29,31,46,48,73,85],"short":[11,13,40,57,63,73,82,87],"static":[],"super":16,"switch":11,"true":[1,2,7,11,15,25,31,33,44,50,55,56,68],"try":[8,10,11,13,25,44,68],"var":[7,9,10,13,23,
70],"while":[4,11,13,19,20,25,70],a00:[38,61],a_record:[43,67],aaaa:[11,13,29,31,43,48,50,67,70],aaaa_record:[43,67],aadata:55,abbrevi:[28,47],abc123def456:48,abil:[2,25,84],abl:[5,11],about:[8,10,11,13,15,18,24,30,31,32,41,46,49,50,54,64,73,85,87],abov:[1,10,12,13,15,17,69,70,73,78,82],absolut:15,accept:[2,13,15,25,74],access:[2,5,7,8,10,11,13,15,16,25,31,33,38,50,56,61,69,70,73,83,88],accesscontrolalloworigin:7,accomplish:[],accord:[11,44,68],account:[25,82],accur:[7,12,13],ack:11,acl:[31,50],acquir:[73,87],acronym:13,across:[4,8,11,13,19,29,31,48,50],act:[11,18,78],action:[2,11,18,31,47,50,61],activ:[1,8,11,13,31,41,44,50,64,68,87],active_directori:[43,67],actual:[8,11,15,18,82,85],adapt:[38,61],add:[1,2,5,8,10,11,13,14,15,16,17,23,25,31,50,53,70,74,82,83,88],addit:[2,10,13,20,25,31,50,78,82],addition:11,additional_config_json:[42,65],address:[4,7,8,9,10,11,13,18,20,25,31,34,38,39,44,50,53,57,61,62,68,70,71,74,85],addressline1:[44,68],addressline2:[44,68],adher:[40,63],adjust:[9,
13],admin:[],admin_down:[40,63,82],administ:13,adminpassword:16,adminstr:8,advanc:11,affect:82,affili:25,after:[2,8,10,11,18,20,23,25,70,74,83],afterward:4,again:[10,17,25,82],against:[5,11,13,16,25,82],agent:[25,44,68],aggreg:[19,29,48,82],agre:82,aid:11,albuquerqu:[34,57],alert:[2,25,31,38,42,44,47,48,50,61,65,68],algorithm:[4,11,48],alias1:[31,50],alias2:[31,50],alias:[31,50],aliv:[2,25],all:[2,5,7,8,11,13,14,15,16,18,19,24,25,29,31,41,44,47,48,50,53,55,64,68,73,74,76,78,81,82,83,84,85,86,87],all_graph_url:15,allow:[1,2,5,7,8,11,13,15,17,19,24,25,31,48,50,53,61,70,73,74,78,82,83,85,86,88],allow_ip6:8,allow_ip:8,almost:11,along:[15,16,25],alreadi:[11,14,16,18,31,50,85],also:[0,8,11,13,16,17,25,31,50,51,73,76,78,82,83,85],alter:[31,50],altern:5,although:[10,81],alwai:[],amount:[7,8,11,13,44,68],anaconda:[8,11],analysi:[19,81],angular:[],angularj:[69,84],ani:[2,4,5,6,8,10,11,13,15,16,25,30,31,41,49,50,64,73,82],anonym:15,anoth:[10,11,13,15,23,70,82],answer:[2,10,11,13],any_map:11,an
yth:[11,32,54],anywai:11,anywher:11,aof_current_rewrite_time_sec:[],aof_en:[],aof_last_bgrewrite_statu:[],aof_last_rewrite_time_sec:[],aof_last_write_statu:[],aof_rewrite_in_progress:[],aof_rewrite_schedul:[],apach:[0,16,17,18,72,81,82,85,86],apachetrafficserv:18,api:[],apichang:[30,49],apiport:[29,48],apnic:[27,45],app:[8,9,10,16,25,41,64,69],appear:[11,18],appli:[8,11,25,31,50,78,86],applic:[2,5,8,10,11,13,14,16,22,23,25,38,44,61,68,69,70,82,83],applicationcontext:70,applicationproperti:70,approach:[1,25,82],appropri:[4,8,11,13],apr:[10,25],april:81,arch_bit:[],architectur:[79,80,81],archiv:10,area:[5,19,25],aren:29,argument:25,around:[13,85,87],arrai:[25,27,28,29,31,35,38,42,44,46,47,48,50,51,53,55,58,61,65,68],articl:78,artifact:70,asap:[11,44,68],ascii:8,asdasdasdasfasg:13,ashburn:[34,57],ask:[10,14,17,25,82],asn:[],asnsjj:25,aspect:70,asset:[12,13,82],assettyp:[44,68],asseturl:[44,68],assgin:11,assign:[],assist:8,associ:[11,13,16,29,31,48,50,53,84],assum:[10,11,15,18,69,74],as
sumpt:[7,16],astat:[8,25,78,82],astats_over_http:8,ater:10,atl:55,atlanta:[36,47,55,59],atsec:[13,30,38,41,47,49,55,61,64,85],atsmid:[32,54],attempt:[11,14,18,85],attribut:[5,10],audio:19,auger:76,auth:[7,11,25,31,50],authent:[],author:[2,10,11,13,16,25],authorit:[10,13,20,85],auto:[13,70],autoconf:10,autofil:11,autom:[13,73],automak:10,automat:[9,10],autonom:[11,27,45],avail:[2,7,8,11,13,19,23,25,26,28,29,31,40,44,47,48,50,63,68,70,79,82,85],availablebandwidthinkbp:[8,29,48],availableperc:[29,31,48,50],avali:10,averag:[8,46,51,82],avg_ttl:[],avoid:[1,5],awai:11,await:10,awar:[11,18,86],b3ff:53,b42be0749415cefd1d14e1a91bb214845b4de556:2,back:[4,17,25,44,68,82,85],background_fetch:[11,31,50],backlog:13,backplan:[38,61],backup:[4,11],bad:8,badass:14,balanc:13,balancermemb:[],bandwidth:[8,11,15,31,46,50,84,85,87],bar:[15,17,18,20,29,31,33,39,42,48,50,56,62,65,85],base64:[31,48,50],base64encodedcrt1:48,base64encodedcrt2:48,base64encodedkey1:48,base64encodedkey2:48,base:[],base_url:[9,25
],bash:[9,11,12],basi:[73,85,87],basic:[],baz:[39,62],bbt:25,bcm5720:[38,61],becaus:[5,8,85],becom:[],been:[1,2,8,10,11,13,15,16,23,70,82],befor:[1,7,8,10,11,14,29,68,74,83],begin:[7,10,46,51,82,85],behalf:18,behavior:[13,82],belong:[57,59,61],below:[8,9,11,13,14,15,18,20,21,24,25,81,82,85,86],beltwai:[36,59],best:[10,11,13,74,85],beta:[11,25],better:[10,83,85],between:[4,7,9,11,13,14,15,25,78,82,83,85,86],bin:[7,9,10,11,23,25],binari:[0,13],bind:70,bio:[38,61],bit:[10,11],blacked_out:5,blacklist:25,blank:[8,10,11,15],blob:[],block:[],blocked_cli:[],blue:81,blurb:8,bob:[44,68],bodi:[6,17,18,20],bond0:[11,38,61],bond:11,bool:[31,50],boot:8,bootabl:11,bootproto:11,bootstrap:[7,13,25,70],bot:11,both:[6,10,11,13,18,19,25,31,50,70,82],bottom:[11,14,15,16],bower:69,box:[4,81],bp12g:[38,61],bracket:[11,13],brave:11,breach:11,brief:15,broadcom:[38,61],brought:15,brows:[23,70],browser:[2,7,23,25,83],bsimpson:[44,68],bucket:16,bug:[30,49],build:[8,10,11,12,15,23,25,70,73],built:70,bulk:[],bun
ch:11,bundl:[16,86],busi:[31,50,82],businessunit:[31,50],button:[1,2,6,11,15],bypass:[11,13,31,50],bypassdestin:[29,48],c0a8:13,cabl:76,cacertfil:16,cach:[],cache01:18,cache_group_edg:[47,61],cache_group_mid:47,cache_range_request:[11,31,50],cache_stat:[],cachegroup:[],cachegroup_graph_url:15,cachegroupid:47,cachegroupnam:47,cachegroupparamet:[28,47],cacheretentionpolici:15,cachestat:24,cacheurl:[11,31,50],calcul:[7,11,73],call:[7,9,10,11,13,15,25,76,82,85],callahan:[44,68],can:[],canadian:5,cannot:[31,50,68],capac:[11,29,31,48,50,82,84],care:[11,13,15,44,68,83],carri:85,carton:25,catalina_bas:7,catalina_hom:7,catalina_pid:7,catalina_tmpdir:7,categori:[30,49],caus:[11,44,68,82],caution:11,cb00:10,ccp:53,ccr1:58,ccr:[],ccr_cdn1:50,ccr_cdn:50,ccr_copi:58,ccr_ignor:[40,63],ccr_top:[35,58],ccrdnsttl:[31,50],ccsi:18,cdl:[31,50],cdn1:[10,11,29,48],cdn2:[31,50],cdn:[],cdn_eng:[31,50],cdn_id:[],cdn_name:[],cdn_number_1:[47,50,61],cdn_test2:48,cdn_test:48,cdnid:61,cdnlab:[13,41,64],cdnname:[
7,11,23,29,46,48,50,61],cdu:[9,11,25],cen:[32,54],cent6:5,cento:[],centos65:[8,10],central:19,cert:[],certain:[24,25,70,88],certainli:11,certfil:16,certif:[8,10,16,31,48,50,88],certifact:[],cfg:[8,11,15],cfg_:11,cg_edg:47,challeng:10,chang:[],changeabl:14,changelog:11,channel:76,charact:[5,13],charset:[17,18,20],chart:[69,84,87],check:[],check_extension_bool:[25,42,65],check_extension_num:25,check_nam:9,checkout:[],checkpath:[31,50],chi:[5,13,38,47,61,86],chicago:[28,34,38,47,57,61],child:[4,11,47],choos:[1,2,11,15],chosen:[1,5,11,81],chr:[9,11,25],cidr:[5,8],cisco:76,citi:[10,13,31,34,44,50,57,68],clarif:[13,20],classless:5,classpath:7,clean:[23,70],clear:25,cli:69,click:[1,2,4,5,6,11,14,15],clickabl:11,client:[2,5,11,13,17,18,20,29,31,40,48,50,63,69,70,73,78,82,84,85,86],client_biggest_input_buf:[],client_connect:87,client_longest_output_list:[],clone:[16,23,25,69,70,73],cloog:10,close:[2,11,17,18,82],closest:[70,78,85],cluster:[15,16,86],cmc:[28,47],cmd:2,cms_interfac:9,cname:[2,
11,13,50,53],cname_record:[39,62],code:[5,10,11,13,23,25,31,40,50,63,70,73],codebas:[23,70],codepoint:25,coexist:85,collect:[8,15,23,25,27,28,29,31,38,41,42,44,47,48,50,61,64,65,68,83],collis:25,colorado:[31,50],column:[9,11,25,46,51],com:[5,10,11,12,13,15,17,18,20,23,25,29,31,34,42,44,48,50,57,61,65,68,70,74,85],combin:[78,85,86],comcast:[11,13,23,31,50,70,74,76,81],come:[11,17,25,31,50],comma:[8,11,24],comman:11,command:[1,10,16,25],comment:[8,12,34,41,57,64],common:[0,10,20,25,82,85],commonli:[17,23,25,69,70,73],commun:[13,18,25,70,76,86],compani:[10,14,44,68],compar:11,comparison:[8,86],compass:69,compat:[11,44,68],compil:[10,25],complet:[0,7,10,11,13,14,20,25,70],complianc:18,complic:[3,82],compon:[11,13,15,79,80,81,82,83],comprehens:[10,20],compris:70,comput:15,concaten:[11,25],concept:[21,85],concurr:76,cond:4,condit:[11,13,44,68],conf:[7,10,11,12,13,15,16,23,25,69,70],config:[4,5,7,8,10,11,12,13,14,15,16,25,29,33,40,48,56,63,69],config_fil:[11,29,33,48,56],configdoc:24,confi
gur:[],confirm:[8,11],conifgur:[],conifugr:15,conjunct:[11,82],connect:[2,7,10,11,13,14,15,17,18,19,20,25,29,48,82,85],connect_attempts_max_retri:4,connect_attempts_max_retries_dead_serv:4,connect_attempts_timeout:[4,11],connected_cli:[],connected_slav:[],connector:70,consequ:70,consid:[8,31,50,82,85,86],consist:[4,11,13,15,19,70,78,82,83,85],consistent_hash:11,consol:[23,70],construct:11,consum:[11,19,22,24,25,69,82,84],contact:[25,57],contain:[8,11,13,20,23,69,70,73,86,87],content:[],contenttyp:[31,50],context:18,continu:[10,15,20,74],contribut:[25,75],control:[],conveni:70,convent:[],convers:11,convert:[8,13],cooki:[2,6,16,25,44,68],coordin:[8,29,48,85,86],copi:[10,11,12,13,15,58],copyright:25,core:[11,70],corpor:[25,31,50],correct:[7,10,11,13,15,16,25],correctli:[10,11,13,15],cost:85,could:[8,11,13],count:[7,24,29,31,38,46,48,51,61],counter:82,countri:[10,31,44,50,68],coupl:[13,16],coverag:[],coveragezon:[10,11,29,48],coveragezonejsonurl:11,coveragezoneonli:[29,48],cox:76,coyot:
85,cpan:[10,25],cpanfil:25,cpld:[38,61],cpp:10,cpu:[],cqhm:[5,13],cqhv:[5,13],cr_bar:[29,48],cr_foo:[29,48],cran:26,crconfig:[],creat:[],create_network_lin:11,create_ts_databas:15,creation:[10,48],credenti:[2,13,25],critic:[13,82],cron:[],cronjob:25,crontab:[9,14],cross:[30,49],crossdomain:[11,31,50],crstate:[7,24],crt:[10,16,31,48,50,88],cryptograph:[13,48],csr:[10,31,50,88],css:[12,25],csv:11,cti:25,curl:[2,6,7,10,12,13,16,25],current:[1,5,7,9,10,11,13,16,24,25,30,44,49,68,71,73,81,87],current_client_connect:[11,46,87],currentgbp:[29,48],custom:[10,11,12,15,25,31,50,73,82,83],customiz:83,cycl:7,czf:[11,13,31,50],czm:78,czmap:13,d0d0:[38,61],d1s2:[38,61],d1s4:[32,54],d6xpdv1:[38,61],d903:[38,61],dai:[1,8,11,14,15,20,29,30,48,49,68,73,87],daili:[],daily_bw_url:[11,15],daily_served_url:[11,15],daily_stat:[15,87],dailysummarypollinginterv:15,dailysummaryretentionpolici:15,danc:13,dash:[5,13],dashboard:[15,73],data:[],databas:[],datacran:26,datadeliveryservic:26,datadeliveryserviceserv
:26,datadomain:26,datahwinfo:26,datalink:26,dataloc:26,datalocationparamet:26,datalog:26,dataparamet:26,dataphys_loc:26,dataprofil:26,dataregion:26,datarol:26,dataserv:[26,29,48],dataserverdetail:26,datastaticdnsentri:26,datastatu:26,datatyp:26,dataus:26,date:[1,2,11,13,14,17,18,25,27,28,29,32,33,35,38,40,44,45,46,47,48,51,54,56,58,61,63,68,85],db0:[],dbconf:25,dbix:[10,25],dcchi:[28,47],dccmc:[28,47],deactiv:11,dead:11,dead_server_retry_en:[4,11],dead_server_retry_response_cod:[4,11],deal:82,debug:[2,7,11,14],dec:[2,17,18],decim:13,decis:[70,85],defin:[4,5,8,11,13,25,70,86],degre:13,del:[31,50],delai:[7,70],deleg:[10,13],delet:[2,8,11,16,17,25,29,31,42,47,48,50,53,61,65],delimit:[11,70],deliv:[11,19,76,85],deliveri:[],delivery_servic:[],deliveryprotocol:[31,50],deliveryservic:[],deliveryservice_graph_url:15,deliveryservice_stat:[],deliveryserviceid:5,deliveryservicenam:51,deliveryserviceserv:[26,31,50],dell:[38,61],demand:[31,50],den:86,deni:5,denial:13,denver:[8,10,29,31,39,48,50,
62],depend:[1,10,11,13,25,69,73],dependeci:10,deploi:[8,14,19,41,64,70,79,82,86],deploy:[10,13,70],deprec:[38,61],depth:8,dequeu:[47,61],deriv:[11,13],describ:[11,13,18,31,41,50,53,64],descript:[4,7,8,10,11,13,15,24,25,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68],design:[69,83,84],desir:[6,13,31,50,51,85],desktop:[],destin:[11,13,19,31,50,79,82],detail:[0,8,11,13,20,25,26,30,31,38,47,48,49,50,61],detect:82,deteremin:11,determin:[11,13,25,70,78,82,83,85],dev:[9,15],devel:10,develop:[],devic:[11,78],dhcp:11,diag:11,diagnost:[38,61],diagram:81,did:[13,17],diff:[5,11,74],differ:[4,8,10,11,13,14,15,16,18,20,28,47,82,83,86,87],differenti:[31,50],diffserv:25,dig:[1,2,13],digest:[10,48],digesttyp:48,dilig:13,dimens:82,dir:[10,13],direct:[18,78,86],directli:[11,13,16,18,78],directori:[],disabl:[13,48,50],disallow:5,disclaim:14,discuss:[15,85],disk:[7,8,10,11,25,32,38,54,61,85],dispers:[14,50],displai:[2,9,11,15
,23,24,38,50,61,70,87],displaynam:50,disregard:7,dist:69,distanc:[85,86],distinguish:[4,10],distribut:[0,8,10,13,19,70,76,79,85],divers:82,divert:11,divis:[],division_id:[],division_nam:59,divisionid:59,divisionnam:59,divsion_id:[],divsionid:59,dns_live:11,dns_live_n:11,dns_live_natnl:11,dnsbypasscnam:50,dnsbypassip6:[31,50],dnsbypassip:[31,50],dnsbypassttl:[31,50],dnskei:[11,13,48],dnssec:[],dnssecen:48,dnsseckei:[11,29,48],document:[3,11,13,15,16,18,25,55,72,76,79,82,86],doe:[4,7,8,11,13,18,20,25,31,34,50,57,78,85,86,87],doesn:[11,13,17,25],domain:[],domain_nam:[11,25,29,33,48,56],domainnam:[9,10,29,38,48,61],don:[8,11,25,29,74],done:[2,11,16,69,74],doubl:13,down:[4,7,11,25,31,40,50,63,85],download:[7,10,11,12,15,16,23,70],downsampl:15,downstream:[11,17,31,50],drill:11,drive:[11,73,87],drive_config:11,drive_lett:[8,33,56],drive_prefix:8,driver:[38,61],drop:[4,10,11,25,31,50,82],dropdown:15,ds1:48,ds2:48,ds_1:50,ds_bypass:13,ds_client_geo_unsupport:13,ds_cz_onli:13,ds_miss:13,ds_no
_bypass:13,ds_not_found:13,ds_redirect:13,dscp:[],dsid:[38,44,61,68],dsname:85,dsr:[29,31,48,50],dsrecord:48,dsretentionpolici:15,dsstat:24,dsxmlid:[44,68],due:[11,31,50,82],dummi:74,dummyxmpp:[38,61],dump:11,duplic:[8,86],durat:11,dure:[8,11,14,23,25,70],dynam:11,each:[0,4,7,8,9,10,11,13,15,16,24,25,29,30,31,47,48,49,50,81,82,85,86],earth:78,easi:11,easier:[8,25,70],easili:15,east:[34,57,86],echo:11,eclips:[23,70],econom:[19,79],edg:[0,1,2,4,8,10,11,13,18,25,29,31,38,40,42,47,48,50,61,63,65,70,74,78,82,85,86,87],edge1:[8,10],edge1_cdn1_421:61,edge1_cdn1_421_ssl:[38,61],edge1_top_421_pspp:55,edge_cdn2:[31,50],edge_loc:47,edgeheaderrewrit:[31,50],edit:[2,7,8,9,11,13,15,23,25,41,47,48,50,61,64],editor:8,effect:[1,5,11,13,16],effici:[31,50],either:[11,13,16,85],el6:2,elaps:[],element:5,elig:85,els:15,email:[10,11,31,34,44,50,57,68],emailto:[31,50],embed:[23,25,70],empti:[5,13,58],enabl:[1,4,5,11,13,16,31,48,50],enclos:13,encod:[29,31,48,50],encompass:19,end:[11,13,18,19,24,25,29,31,46,
48,51,78,85],end_dat:[29,31,48],enddat:[46,51],endpoint:[],endtim:24,enform:10,engin:[31,50],enhanc:[25,83],ensur:[7,8,11,12,13,19,23,70,82],enter:[1,7,8,10,11,13,15,25,31,44,50,68,74],enteredtim:[44,68],enterpris:[8,38,61],entir:18,entri:[],env:25,enviro:25,environ:[],epoch:[11,13,24,29,48],epol:[],equal:[5,13],equival:[40,63],err:[29,31,48,50],error:[],especi:[10,74,85],essenti:20,etag:[17,18],etc:[9,10,11,12,16,23,25,70,73,82,83],eth0:[9,61],eth4:11,ethernet:[11,38,61],evalu:[11,82],even:[19,25,74,79,83,86],event:[],eventlog:24,eventu:[23,70],everi:[11,13,14,19],everyth:[0,11,16],evicted_kei:[],exampl:[],exampleurl:[31,50],exce:82,exceed:[11,31,50,82],except:[4,11,13,81,85],exclud:[5,11,85],excludepostalcod:5,exclus:5,execut:[8,10,23,25,70],exist:[5,7,11,13,23,24,25,29,58,70],exit:[7,14],exp:[38,61],expand:[23,70],expat:10,expect:[10,11,13],expens:[11,44,68],experienc:11,experiment:[11,13],expir:[1,2,11,13,17,25,29,44,48,68],expirationd:[29,48],expired_kei:[],explain:[11,16,81],e
xplainatori:11,explan:10,explicit:18,explicitli:[17,82,83],explor:[23,70],expos:[83,87],expres:11,express:[8,11,13,44,68,69],extend:[5,78],extens:[],extensioncheck:9,extensionnam:25,extern:79,extra:10,extrem:[13,82],eyjhdxrox2rhdgeioijhzg1pbiisimv4cglyzxmioje0mjk0mdqzmdz9:25,eyjlehbpcmvzijoxndi5ndaymjaxlcjhdxrox2rhdgeioijhzg1pbij9:25,eyjlehbpcmvzijoxndi5ndazodyzlcjhdxrox2rhdgeioijhzg1pbij9:25,eyjlehbpcmvzijoxndq5mta1mti2lcjhdxrox2rhdgeioijmzwrlcmf0aw9ux3vzzxixin0:2,eyjlehbpcmvzijoxndq5mta1otqylcjhdxrox2rhdgeioijmzwrlcmf0aw9ux3vzzxixin0:2,f990d03b7180b1ece97c3bb5ca69803cd6a79862:25,fact:[8,11,82,86],factor:85,fail:[4,5,11,13,25,82],fail_threshold:11,failov:[4,11,31,50],failur:[],fairli:11,fall:85,fallback:5,fals:[7,11,13,31,33,44,50,56,68,82],familiar:21,fast:82,fatal:14,fe1e:53,fe80:53,featur:[],fed:13,fedeat:2,feder:[],federation_user1:2,fetch:[5,11,14],few:10,ffff:13,field:[],fifthpercentil:[46,51],file:[],filenam:11,fill:[5,8,11,76],filter:[6,13,38,61],find:[11,13,18,23,70,78,85]
,finish:[23,70,82],firmwar:[38,61],first:[4,5,6,8,10,11,13,69,81,87],fix:14,fixtur:25,flag:[2,5,11,14,15,31],flush:10,fmt:73,folder:8,foll:11,follow:[1,2,4,5,7,8,9,10,11,12,13,15,16,18,19,20,23,25,31,69,70,73,79,85,88],font:[],foo:[6,11,17,18,20,29,31,33,39,42,48,50,56,62,65,85],foobar:[35,58],foober:[31,50],fooconfig:[33,56],footprint:76,forc:[8,11,44,68],forcesystemexit:7,form:[0,7,11,13,25,76],format:[],former:8,forum:76,forward:[],found:[2,7,13,15,16,18,20,25,31,50,88],four:[4,70,82],fqdn:[7,9,10,11,13,23,25,29,31,38,48,50,61,70,85],frag:82,framework:[25,83],fred:11,free:25,freeform:[32,54],frequenc:[7,13],fri:[41,64],from:[0,2,4,5,7,8,10,11,12,13,15,16,17,18,19,20,23,24,25,31,40,41,44,50,58,63,64,68,69,70,73,78,79,82,83,84,85,86,87],fsa:5,fulfil:[20,25],full:[4,10,11,13],fulli:[10,13,25],fullnam:[44,68],fullscreen:15,fun:[17,18,20,85],further:[2,5,11,25,81],futur:[8,13,81],gain:85,gatewai:[11,38,61],gather:[24,25,70,87],gbp:[11,31,50,87],gcc:10,gcc_version:[],gener:[],genisoima
g:10,geo2:5,geo:[],geo_no_cache_found:13,geoblock:13,geoenabl:[29,48],geograph:[19,82,86],geographi:[11,82],geoip2:[10,13],geoip:10,geolimit:[],geolimitcountri:50,geolimitredirecturl:50,geolit:10,geolite2:10,geolitec:8,geoloc:[5,8,10,11,13,29,48,70,71],geolocation6:[8,29,48],geoprovid:50,get:[],gettext:10,gid:[44,68],gigabit:[31,38,61],git:[11,23,25,70,73],github:[15,16,25,74,76],give:11,given:[2,7,11,13,18,25,29,44,48,68,82,85],global:[2,8,11,15,31,41,50,64,82],globalmaxmbp:[31,50],globalmaxtp:[31,50],gmt:[2,11,17,18,25,85],goal:19,goe:[4,11,13,31,50],golang:87,good:[11,25,74,76],googl:76,goos:[10,25],gopath:[15,73],got:[2,11],gototarget1:6,govern:82,grafana:[11,15,73,87],grafana_proxi:[],grafana_url:15,grafanahost:15,grafanaurl:[],grant:[16,25],graph:[],graphic:11,greater:[13,16,73],green:15,grei:11,group:[],grow:13,grunt:69,guarante:8,h710p:[38,61],hack:[7,11,29,48],had:17,hand:11,handl:[5,11,31,50,82],handshak:11,happen:13,hard:[8,11],hardcod:25,harden:83,hardwar:[],hardwareinfo
:[38,61],hash:[4,11,13,29,31,38,41,44,46,47,48,50,51,61,64,68,70,78,85],hashid:[29,48],hasnegativecachingcustom:[31,50],hasoriginaclwhitelist:[31,50],hasorigindynamicremap:[31,50],hassignedurl:[31,50],hat:[8,11,17,18],have:[2,4,8,10,11,13,15,16,17,18,20,25,70,74,82,85,86,88],hdr_rewrit:4,hdr_rw_:11,head:11,header:[],header_regexp:11,header_rewrit:11,headerrewrit:[31,50],headerrewriteedg:[31,50],headerrewritemid:[31,50],headerrewriteredirectrout:[31,50],health:[],healthi:11,healthparam:[7,29,48],heart:11,heath:7,help:[],helper:25,here:[3,8,11,14,15,16,25,31,41,44,50,64,68,76,88],hierarchi:85,high:[8,25,29,34,48,57],higher:[4,8,10,15,78],highest:[8,10],highli:15,hint:11,hire:10,histor:7,histori:[11,24,29,48],hit:[8,10,11,17,25,31,50,82,85],hmac_md5:11,hmac_sha1:11,home:[15,25],homebrew:25,honor:[13,17,70],hook:25,hop:[76,85],hope:73,horizont:85,host:[7,10,11,13,14,16,17,18,20,25,31,38,39,50,61,62,70,85],host_nam:[11,25,38,61],host_regexp:[11,31,50],hostnam:[7,9,10,11,13,16,18,23,25,26
,29,31,32,38,48,50,54,61,78,85,87],hot:[10,14,82],hou:86,hour:[11,44,68],hover:11,how:[],howev:[9,11,13,83],html:[5,10,17,18,20,42,65,69,85],http11protocol:70,http:[],http_live:11,http_live_natl:4,http_live_natnl:11,http_no_cach:11,httpbypassfqdn:[31,50],httpd:10,httponli:[2,25],httpsport:[38,61],human:[10,11,38,61],hundr:[8,19,86],hwinfo:[],hypertext:20,hypnotoad:10,icon:11,id_copy_from:[],idcopyfrom:58,idea:74,identifi:[8,11,17,25,27,28,29,30,32,45,47,48,49,54],ignor:[11,31,50],illustr:20,ilo:[9,11,25,42,65],ilo_ip_address:[25,42,65],ilo_ip_gatewai:[],ilo_ip_netmask:[],ilo_p:[42,65],ilo_password:[],ilo_usernam:[],iloipaddress:[9,38,61],iloipgatewai:[38,61],iloipnetmask:[38,61],ilopassword:[38,61],ilousernam:[38,61],imag:[2,4,11,25,31,41,50,64,76,85],img:[2,44,68],immedi:11,impact:[11,82],imper:13,implement:[11,26,79,81],improv:11,inaccess:[8,11,44,68],inact:[31,50],inc:[38,61],incept:13,inceptiond:[29,48],includ:[5,7,8,11,18,23,25,31,40,50,63,69,70,81,82,84,85],includepostalcod:5,
incom:13,incorpor:[10,25],independ:82,index:[10,11,16],indic:[],individu:[11,15,82],inf:70,influenc:[11,13,17,82,87],influxdata:15,influxdb1:[],influxdb2:[],influxdb3:[],influxdb:[],influxdb_tool:15,influxpassword:15,influxurl:15,influxus:15,info:[],info_url:[42,65],inform:[1,8,10,11,13,15,16,18,23,24,25,29,31,41,48,50,64,68,70,71,74,82,83,85,86,88],infourl:[8,31,41,50,64],init:[10,13,16,70],initi:[10,11,14,25,44,50,68,74],initialdispers:50,inlin:[11,12],input:[11,25,85],insecur:25,insert:[18,20,85],insight:[69,82,84],instal:[],instanc:[7,8,10,11,23,25,31,38,41,50,61,64,69,70,73,82,85],instance_nam:[8,41,64],instantaneous_ops_per_sec:[],instruct:[8,10,15,16,31,50],intact:25,inted:11,integ:[47,61],integr:[15,25,38,61,70,79,80],intel:[38,61],intend:[5,11],intent:11,inter:5,interact:[14,83],interest:[13,18],interf:85,interfac:[8,11,14,25,38,61,70,82,83],interface_mtu:[],interface_nam:[],interfacemtu:[38,61],interfacenam:[29,38,48,61],intern:[6,11,13,16,25,40,63,76,79,81],internet:[13,1
8,19,79,85],interv:[5,7,11,13,15,25,29,48,82,83,87],intervent:11,introduc:80,introduct:[],invalid:[],invok:11,involv:[],ip6:[29,48],ip6_address:25,ip6_gatewai:[],ip6address:[9,38,61],ip6gatewai:[38,61],ip_address:[25,42,65],ip_allow:[8,11],ip_gatewai:[],ip_netmask:[],ipaddr:11,ipaddress:[9,38,61,71],ipaddrr:11,ipgatewai:[38,61],ipnetmask:[38,61],ipv4:[2,5,8,9,11,13,18,20,25,31,38,50,53,61,70,71,74],ipv6:[2,8,9,11,13,25,31,38,50,53,61,70,71,74],ipv6addr:11,ipv6gatewai:11,ipv6routingen:[31,50],ipwhitelist:5,isact:[42,65],iso8601:[46,51],iso:[],isolinux:8,isp:11,issu:[11,70,74,82,85],item:[8,13,24,31],iter:25,itself:[13,22,25],ivh:[10,15],jan:85,jane:[34,57],jar:[7,70],java:[],javascript:[25,69,73],jdk:[16,23,70],jeff:8,jemalloc:[],jenkin:13,jetti:[23,70],jmx:70,job:[11,44,68],joe:15,john:[34,57],jpg:[44,68],jre_hom:7,json:[],junit:[23,70],just:[10,11,24,31,50],jvd:[8,25],kabletown:[],kabletown_cdn:[7,10],kbaletown:[30,49],kbp:[31,51,87],keep:[2,8,11,14,25,85],kei:[],kepler:[23,70],kep
t:[7,13,25],keyfil:16,keypair:[29,48],keyspac:[],keyspace_hit:[],keyspace_miss:[],keystor:[11,13,88],keysus:16,keyword:[8,44,68],kick:82,kickstart:[],kickstart_create_network_lin:11,kickstart_drive_config:11,kind:[11,13],kl0tevax:7,know:[11,85],knowledg:13,known:[10,11,82],ks_script:11,ksk:[1,11,13,29,48],kskexpirationdai:[29,48],l9v:5,l9w:5,label:[13,29,31,48],lacp:11,lai:13,laika:25,land:11,larg:[8,13,19,82,85],larger:[78,85],last:[7,11,17,18,25,27,28,32,33,35,38,40,45,47,54,56,58,61,63],last_upd:[28,33,56],lastupd:[25,27,28,30,31,32,35,38,40,43,45,47,49,50,54,58,61,63,67],lat:11,latch:11,latenc:[18,82],later:[5,10,11,15,25,82],latest:[5,8,16],latest_fork_usec:[],latitud:[11,13,28,29,31,47,48,50],latter:8,launch:11,lax:[41,64,86],layer:[11,31,50,78,85],ldap:10,ldn:[18,20,85],learn:18,least:[1,10,11,74],leav:[10,11,15],left:[8,10,11,25],length:[2,10,13,17,18,20,25,85],lenienc:7,less:[11,15,31,50,73,82,85,87],letter:[10,11],level:[1,2,9,11,13,25,29,30,31,38,42,44,47,48,49,50,61,65,6
8,82,85],lib:[9,10,25],libcurl:10,libgomp:10,libidn:10,libpcap:10,librari:10,libtool:10,life:8,lifecycl:[38,61],lifetim:8,light:[25,38,61],lighten:[8,41,64],like:[8,11,13,14,17,25,78,83,85],limit:[8,11,31,47,50,85],line:[10,11,15,16,25,31,50],linear:11,link:[10,11,73,87],linux:[8,11,23,25,69,70,73],list:[2,4,5,8,9,11,18,24,25,29,31,40,42,44,48,50,53,63,65,68,70,71,85],list_bucket:16,list_kei:16,listen:[11,16,25,38,61,70],live4:5,live51:5,live5:5,live5_low_bitr:5,live:[5,11,13,20,25,29,44,48,53,68],load:[8,10,11,13,16,25,41,42,64,65,82,85],load_schema:25,loadavg:[8,29,48],loadbalanc:11,loader:10,local0:9,local:[],localhost:[2,9,10,15,23,25,69,70],localus:[44,68],locat:[],location1:57,log4j:[11,13],log4perl:10,log:[],log_level:[9,14],logic:[5,8,86],login:[2,6,7,10,11,15,16,25,44,68],logo:[8,41,64],logourl:[8,41,64],logout:[11,44,68],logsen:50,long_desc:[31,50],long_desc_1:[31,50],long_desc_2:[31,50],longdesc1:[31,50],longdesc2:[31,50],longdesc:[31,50],longer:[8,11,20,44,68,70],longest
:8,longitud:[11,13,28,29,31,47,48,50],look:[16,18,20,25,85],lookup:[9,11,13,31,50],loop:5,lot:[11,74],low:13,low_bitr:5,lower:[4,8,85],lowest:85,lru_clock:[],ltd:10,m3u8:[5,13],machin:[10,70],maco:[23,25,69,70,73],made:[2,11,14,15,25,30,44,49,68],mai:[1,4,9,10,11,13,14,25,40,44,63,68,70,81,82],main:[11,18,23,25,38,61,70],mainten:[11,31,50],maintenanceperc:[29,31,48,50],major:[14,19,79],make:[4,5,7,8,11,13,15,19,25,29,31,44,50,68,70,73,74,79,82,85,86],manag:[],mangement:25,mani:[8,10,11,13,19,25,44,68,79,82,83,85],manipul:11,manner:[25,83],manual:[1,2,11,13,15,70,74],manufactur:[38,61],map:[2,11,18,20,29,31,48,50,53,71,74,78,85],mar:[41,64],mark:[11,25,31,50,82],master:25,master_repl_offset:[],match:[5,7,8,9,10,11,13,17,18,20,25,42,44,65,68,86],matchlist:[29,31,48,50],matchset:[29,48],matchtyp:[29,48],matter:11,matur:10,maven:[23,70],max:[2,9,11,13,17,25,29,31,44,46,48,51,68,87],maxdnsansw:[31,50],maxdnsipsforloc:[29,48],maxgbp:[29,48],maximum:[8,11,13,17,25,31,38,50,61],maxkbp:[46,8
7],maxlibrarysizeestim:[31,50],maxmind:[10,13,50,78,85],maxrevaldurationdai:8,mayb:18,mbp:11,md5:11,mean:[4,8,11,13,14,17,29,31,48,50,82],meant:[15,88],measur:[31,50,85,87],mechan:[11,13],media:[8,19,76,79],median:31,mega:2,mem_alloc:[],mem_fragmentation_ratio:[],member:7,memori:11,mention:81,menu:[],merg:82,messag:[],met:[31,50],meter:85,method:[2,8,11,13,25,31,44,50,68,84],metric_typ:[29,31,48],metrictyp:[46,51],mgmt_ip_address:[],mgmt_ip_gatewai:[],mgmt_ip_netmask:[],mgmtipaddress:[38,61],mgmtipgatewai:[38,61],mgmtipnetmask:[38,61],mid1:[8,10],mid:[0,4,8,10,11,18,31,38,40,41,50,61,63,64,74,78,86],mid_loc:[28,47],middl:18,midheaderrewrit:[31,50],midnight:87,might:[11,13,25,82],migrat:[10,13,25],mile:[8,34,57],million:[19,79],millisecond:[11,13,24],min:[8,29,31,46,48,51],mind:25,mine:[73,87],mini:[38,61],minim:[8,10,18,19,70],minimum:[11,20,29,48,70],minut:[10,11,20,25,70,83],misc:[2,8,11,16,25],miscellan:[11,23,25],miss:[11,13,29,31,48,50,73,82,86],misscoordin:[29,48],misslat:[31,
50],misslong:[31,50],mix:8,mkdir:8,mkisof:11,mmdb:[10,13],mnt:11,mod:7,mod_ssl:10,mode:[7,14,25],model:[38,61],modif:11,modifi:[11,13,17,18,44,68,69,70],modul:[10,70],modulu:10,mojo:[10,25],mojo_mod:25,mojolic:10,mojolici:[2,6,10,25,83],mojoplugin:25,mon:[],monitor:[],monkei:[],monthli:15,morbo:25,more:[1,3,8,10,11,13,15,16,18,20,25,31,38,41,50,61,64,68,76,82,85,86],most:[8,9,11,13,17,23,25,38,61,69,70,73,85],mostli:[11,13,18,25],mount:11,move:[11,85],movi:[11,76],mp4:13,mpfr:10,msec:2,msg:2,mso:[4,11],mtu:[9,11,25,38,61],much:[15,25,85],multi:[],multipl:[4,8,11,19,31,41,50,64,86],multiplexing_api:[],multipli:11,multisiteorigin:[31,50],must:[2,5,6,7,9,10,11,13,18,25,31,50,58,88],mutual:5,mvn:[23,70],my_ds_1:50,my_ds_2:50,my_ds_displayname_1:50,my_ds_displayname_2:50,my_vod1:50,mycdn:16,mydeliveryservic:13,mydivision1:[52,59],myhead:13,myorigin:[31,50],myphylocati:57,myphylocation1:57,myregion1:[57,59],mysecret:15,mysql:[10,25,83],mysqld:10,n0h:5,n6g:5,name:[],nameserv:11,namespac:25
,narrow:[7,11],nation:13,natur:25,navig:[],nearest:[11,70,78],necessari:[1,2,8,10,11,13,15,16,44,68,70],necessarili:[74,85,86],need:[0,1,5,7,8,9,10,11,13,14,15,16,23,25,31,44,50,55,68,69,70,73,74,83],neg:[31,50],negativecachingcustomizationnot:[31,50],neither:18,net:[1,2,6,7,10,11,13,14,15,16,18,29,30,31,33,35,38,41,48,49,50,56,58,61,64,70],netmask:[11,38,61],network6:11,network:[],network_lin:11,neustar:50,never:[40,63],newcastl:[29,31,48,50],newcount:[30,49],newdir:8,newli:8,newlin:11,newlogcount:[30,49],newus:[44,68],next:[10,23,70,81],ngb:13,ninetyeighthpercentil:[46,51],ninetyfifthpercentil:[46,51],nix:[23,25,69,70,73],no_dns_just_forward_to_par:11,nodata:13,node:[12,15,69,84],nodej:12,nodenam:16,nodesourc:12,noerror:[2,13],nolq:25,non:[5,7,11,14,25,31,50,82],none:[11,14,17,23,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,54,55,56,57,58,59,60,61,62,63,64,65,67,68,70],nor:18,normal:[11,13,85],notabl:8,note:[],notic:2,notimp:13,now:[1,2,6,10,11,15,16,
29,40,48,63,68,70,74,82],npm:69,nsec3:13,nsec:13,nsf:25,number:[1,7,10,11,13,14,15,24,25,27,29,30,31,38,40,45,48,49,50,61,63,74,82,85],numer:25,nxdomain:13,nyc:[30,49,85,86],object:[8,11,17,25,44,68,82,85],objectnam:[44,68],objecttyp:[44,68],obsolet:[],obtain:[2,10,13,18,25,86],occur:[4,11,13,18,25,30,49,82],octet:10,odol:[13,30,32,49,54,55],off:[13,15,16,25,74],offer:85,offlin:[15,29,31,40,48,50,63,82],ofqdn:4,often:[11,19,20,85,86],old:11,older:[11,13,76],omg:53,omit:11,onc:[0,1,7,10,11,13,15,16,25,73,87],onli:[1,2,5,11,13,15,16,17,18,24,25,31,33,37,44,50,56,60,68,69,71,81,82,83,86,88],onlin:[13,15,29,31,38,40,48,50,61,63,74,82],onward:13,ooff:[29,48],opcod:2,open:[11,18,20,23,25,70,76,79,81,85],openssl:10,oper:[],oppos:18,opposit:25,opt:[7,9,10,12,13,14,15,16,23,25,70],optim:[19,70,78,85],optimist:[25,82],option:[],oracl:25,order:[0,1,4,9,10,11,15,16,25,74,87,88],orderbi:[26,31,50],org:[4,11,31,50],org_loc:47,organ:[10,11,31,50],organiz:10,orgserverfqdn:[31,50],orig:10,origin:[],
origin_tp:[29,48],originhead:[31,50],originshield:50,origintestfil:[31,50],originurl:[31,50],orm:25,orphan:11,ort:[8,9,11,14,16,25],osvers:8,other:[0,4,5,8,10,11,13,14,18,20,25,31,40,50,63,82,83,84,85,86],otheroriginsecur:[31,50],otherwis:[1,5,11,40,63],otr:25,ott:[29,31,48,50],our:[11,16,75,76],out:[8,11,13,14,18,25,38,44,61,68,76,82],out_byt:51,outag:[11,82],outlook:82,output:[7,10,11,82],outsid:[11,13,85],over:[11,13,19,25,29,46,48],overal:[11,82,84,87],overflow:[29,31,48,50,82],overflowcdn:[31,50],overflowservic:[31,50],overload:[11,44,68,85],overrid:[11,13,25,70],overridden:70,overview:[],overwrit:[8,25],own:[11,15,70,82,85],owner:[18,25],pack:[38,61],packag:[],packet:[11,25],page:[1,8,9,11,12,14,15,31,41,50,64,75,76,85],pagin:[31,50],pair:[11,13],pakistan:76,panel:15,panelid:15,param:[7,11],paramet:[],parameter_id:[28,47],parameterid:[29,48],parent:[],parent_cachegroup:[],parent_cachegroup_id:[],parent_origin:[4,11],parent_pend:14,parent_proxi:11,parent_proxy_rout:4,parent_pro
xy_routing_en:11,parentcachegroup:47,parentcachegroupid:[28,47],parentcachegroupnam:[28,47],pars:5,part1:11,part:[5,6,8,11,13,38,48,61,86],parti:[5,29,31,48,50,76],partial:24,particip:[],particular:[18,78,82,85,86],parts0:11,parts1:11,pass:[10,11,16,25,31,50,73],password:[2,7,10,11,13,14,15,16,23,25,38,44,61,68,84,88],past:[13,15],path:[2,9,11,13,15,18,20,25,31,42,44,50,65,68,85],path_regexp:11,pattern:[6,31,50],pcre:[11,44,68],peak:[11,82],peakbpsestim:[31,50],peaktpsestim:[31,50],peer:[7,24,82],peeroptimist:7,peerstat:24,peewe:[44,68],pend:[11,44,68],per:[11,13,20,23,24,27,31,45,50,70,84,85],per_parent_connect_attempt:11,perc:[38,61],perceiv:25,percent:11,percentag:[11,29,31,48,50],perform:[0,2,4,5,11,13,16,18,25,31,50,69,70,74,82,84,85,87],period:[9,11,13,25,83],perl5:[9,10,25],perl5lib:[9,25],perl:[],perltidyrc:25,permiss:10,permut:11,persist:[],perspect:83,pertain:82,pessimist:25,peta:[],phase:10,philosophi:82,phl:86,phone:[34,57],phonenumb:[44,68],phrase:10,phys_loc:[],physic:
[],physloc:[38,61],pick:8,pictur:3,pid:7,pin:[13,25],ping:[9,11,16,25,42,65],pingabl:25,pipe:11,pittsburgh:[27,45],pki:[10,16],place:[11,13,15,18,74],plai:25,plan:[31,50],plane:[21,81],planet:78,platform:76,pleas:[8,10,11,13,25,44,68],plocat:[38,61],plugin:[8,10,11,25,31,44,50,68,78,82],png:[41,64],poc:[34,57],point:[7,11,13,16,20,31,50,57],polici:15,poll:[5,7,8,10,11,13,15,25,29,48,70,74,82],pool:7,pop:11,popul:[11,44,68],popular:11,populateddimmslot:[38,61],port:[7,10,11,13,15,16,18,20,25,29,38,48,61,70,85,88],portal:[],portion:[13,18,31,50,70],posit:[25,82],possibl:[11,15,19,70,79,85],post:[2,10,13,25,29,31,38,42,44,47,48,50,52,53,57,58,59,61,65,68],post_instal:10,postal:5,postalcod:[44,68],postgr:[10,25],postgresql:83,postinstal:[8,10,25],power:[31,38,50,61],powercap:[38,61],poweredg:[38,61],powerst:[38,61],ppl:10,practic:13,pre:[8,11,13,15,16,29,31,48,50,70],preced:4,precis:13,preconfigur:25,prefer:18,prefix:[11,78],prepar:5,presenc:8,present:[],prevent:[8,11,25,31,50,82],previ
ou:[11,18],previous:18,primari:[4,11,35,58],primarili:[69,84],prime:11,primer:11,print:[14,25],prior:[13,70],pristin:[31,50],priv:16,privat:[10,13,16,25,29,31,48,50,83,88],priveleg:2,privileg:[10,13,88],privlevel:[37,60],probabl:11,problem:[11,73,82],proce:[10,11,25],proceed:10,process:[5,8,11,13,14,15,23,46,47,61,70,85,87],process_id:[],product:[8,10,15,16,25,41,64,76],profil:[],profile_copy_from:58,profile_nam:[33,56,58],profilecopyfrom:58,profiledescript:[29,31,48,50],profileid:[29,48],profilenam:[29,31,48,50],program:[8,87],programmat:25,project:[],prompt:[7,10],prop:16,propag:[11,82,83],proper:13,properli:[1,10,11],properti:[8,10,11,13,25,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,70,85],propos:7,proprietari:78,protect:82,protobuf:16,protocol:[],prove:25,provid:[10,11,13,18,19,23,25,27,29,31,45,50,69,70,82,84,87],provinc:10,provis:[18,25,31,50],proxi:[],proxy_auth_to_par:11,proxy_nam:[33,56],prox
ypass:[],proxypassrevers:[],pssc:[5,13],publicli:25,publish:[7,13,24],publishdsst:7,pubsub_channel:[],pubsub_pattern:[],pull:[8,11,23,41,64,70],puppet:14,pure:11,purg:[],purge_allow_ip:8,purpos:[8,25,41,64],push:[8,11],put:[2,5,11,13,15,16,18,25,31,40,47,48,50,53,61,63,66],python:11,qclass:13,qname:13,qrp:25,qstringignor:[31,50],qtype:[5,13],qualifi:[10,13,25],qube:76,queri:[2,7,11,13,15,16,24,31,38,44,46,50,51,61,68,85,87],querystringhandl:[31,50],querytim:[29,48],question:[2,10,14,76],queue:[],queue_upd:[47,61],queueu:11,quick:[],quickli:[11,15],quid:[],quit:[10,20,85],quot:13,r720xd:[38,61],rack:[38,61],ram:[7,10,11,13,85],random:[11,14,18,20],rang:[8,11,31,50],rangerequesthandl:[31,50],rank:4,rascal:[],rascal_cdn:7,rate:[31,50],ratelimitinggbp:[31,50],ratelimitingtp:[31,50],rather:[11,44,68,86],ratio:[11,25],raw:[7,11,15,24,31,50,82],rcode:13,rcvd:2,rdb_bgsave_in_progress:[],rdb_changes_since_last_sav:[],rdb_current_bgsave_time_sec:[],rdb_last_bgsave_statu:[],rdb_last_bgsave_tim
e_sec:[],rdb_last_save_tim:[],rdtl:[5,13],read:[10,11,12,25,37,60,70,82],readabl:[10,11,38,61],readi:[9,10,11,25,74,83],readm:11,real:11,realist:18,realli:11,reason:11,receiv:[11,13,18,20,25,85],recent:[11,24,25],recommend:[0,8,15,41,64],recor:48,record:[1,11,13,14,16,31,33,48,50,56,70,85],recreat:11,recurs:2,red:[8,11,17,18],redefin:10,redhat:2,redi:[],redirect:[],redirecturl:5,redis_build_id:[],redis_git_dirti:[],redis_git_sha1:[],redis_mod:[],redis_vers:[],redo:25,reduc:[18,82],redund:[8,11,78,82,85],ref:[31,50],refer:[],referenc:[8,48],reflect:[8,16,74],refresh:[11,13,29,48,82],refus:[13,25],regard:85,regardless:[4,13,82],regener:[1,11],regex:[5,8,11,29,31,44,48,50,68],regex_remap:11,regex_revalid:[8,11,44,68],regexp:[],regexremap:[31,50],region:[],region_id:57,region_nam:57,regional_geoblock:5,regionalgeoblock:50,regionid:57,regionnam:57,regist:[9,25],regular:[8,11,13,44,68,82,83],reject:[],rejected_connect:[],rel:[8,11,13,41,64],relat:[8,11,13,25,27,45,82],relationship:[4,13,8
6],releas:[],reliabl:13,reload:13,remain:[10,82],remap:[11,18,29,31,48,50,82,85],remap_pseudo_hook:4,remap_requir:11,remap_stat:8,remaptext:[31,50],remedi:73,remot:[11,38,61],remov:[8,10,11,44,68],repeat:[11,29,48],repl_backlog_act:[],repl_backlog_first_byte_offset:[],repl_backlog_histlen:[],repl_backlog_s:[],replac:11,replic:15,replica:11,repo:[10,11,23,70,73],report:[7,11,14,25,30,40,49,55,61,63,74,82],repositori:[10,23,25,69,70,73],repres:[5,13,29,48],request:[2,4,5,6,8,10,11,13,17,18,19,20,25,28,29,30,31,33,38,42,44,46,47,48,49,50,51,52,53,56,57,58,59,61,65,66,68,70,82,84,85],requir:[],requisit:15,rerr:[5,13],reserv:25,reset:[17,25,44,68,84],reset_password:[44,68],resid:70,resign:11,resolut:[9,13],resolv:[2,7,10,11,13,18,20,70,85],resolve4:[2,53],resolve6:[2,53],resourc:[12,13,23,25,70],respect:[4,25,82,85],respond:[5,11,13,17,18,20,85],respons:[],rest:[7,10,11,25,82,88],restart:[10,14,16],restrict:[31,50,69,82,84],result:[11,13,18,19,25,31,38,50,61,73],retent:15,retri:[11,14,29
,48],retriev:[5,11,16,18,20,29,31,38,40,42,44,46,48,50,51,53,61,63,65,68,84,85,88],retry_tim:11,reus:[18,19,85],revalid:[],revers:[],review:[55,79],rewrit:[],rfc:[13,20],rgalt:5,rgb:[],rgdeni:5,riak:[],riak_al:8,riak_cor:16,riak_kv:16,riak_search:16,riakserv:16,riakus:16,riakuserpassword:16,right:[11,25],ring:[11,13],rloc:[5,13],robin:[4,11],role:[],rolenam:[44,68],roll:[],rollup:87,root:[8,9,10,11,16,23,70],round:[4,11],rout:[],router:[],router_host_nam:[],router_port_nam:[],routerhostnam:[38,61],routerportnam:[38,61],routingtyp:[31,50],row:[11,31,38,50,61],rpm:[],rsa:10,rtr:[9,11,25,38,61],rtype:[5,13],rubi:69,rule:[5,11,18,31,44,50,68,82,85],run:[],run_id:[],rurl:[5,13],safer:11,sai:[3,11,15,82],salt:11,same:[4,5,6,8,11,13,15,17,18,31,44,50,68,82,83,85,86],sampl:[],sanjos:[28,47],sass:69,sat:25,satisfi:[31,50],save:[8,10,14,15,82],sbt:25,scalabl:85,scale:11,scenario:[13,18,85],schedul:[11,44,68],schema:[10,16,25],scheme:11,scratch:[0,8],screen:[1,3,4,6,8,10,11,15,41,64],screensho
t:1,script:[8,9,10,11,14,15,16,23,25,70],script_fil:[42,65],scroll:14,sda:11,search:[],search_index:16,sec:[11,16],second:[1,4,8,11,13,15,17,20,31,50,84,85,87],secondari:[29,47,48],secondary_parent_cachegroup:[],secondary_parent_cachegroup_id:[],secondaryparentcachegroup:47,secondaryparentcachegroupid:47,secret:[11,83],secret_passwd:25,section:[2,10,11,13,14,15,20,79,81,85],secur:[11,13,16,31,33,44,50,56,68,83],see:[1,4,8,9,10,11,13,15,16,18,20,21,25,31,38,50,51,61,72,75,76,78,82,83,85,86],seed:[9,10,16,25],seelogconfig:15,seelong:15,select:[],self:[10,11,16],semicolon:[13,70],send:[2,8,11,17,18,20,25,31,40,44,50,63,68,76,82,85],sens:[11,44,68],sensit:83,sent:[10,11,13,19,25,29,31,44,48,50,68,79],separ:[7,8,9,11,13,24,70,83,85],seper:15,seri:[13,46,51,83],serv:[0,4,5,8,11,13,18,24,31,38,50,61,69,78,82,84,86,87],server1:50,server2:50,server:[],server_graph_url:15,server_nam:[],server_typ:31,servercheck:[25,38,61],servercheck_short_nam:[38,42,61,65],serverhostnam:[16,32,54],serverid:[
32,54,61],servernam:[47,50],servic:[],servicealias:[31,50],servicedesc:[31,50],servicetag:[38,61],session:[11,44,68],set:[2,4,5,7,8,10,11,12,13,25,31,41,44,50,64,68,69,70,74,78,82,84,85,86],set_bucket:16,setnumb:[31,50],setup:[11,15,25],setup_6:12,setup_kabletown:25,sever:[4,11,13,20,70,82,83],sha:10,shall:5,shanghai:57,share:[4,8,11,15,82,83,86],shield:[11,50],ship:8,short_nam:[],shortnam:[28,34,47,57],shot:3,should:[1,4,6,7,8,11,13,14,15,16,24,25,44,68,70],show:[1,5,11,20,25],shown:[14,18,25],shutdown:[7,10],side:[11,69,85],sign:[],signal:8,signatur:[10,11,13],signaturemanag:11,significantli:[8,41,64],silent:12,sim:13,similar:[11,18,40,63],simpl:[8,11,13,15,16,25,44,68,70],simple_retry_en:[4,11],simple_retry_response_cod:[4,11],simpli:[0,5,11],simplifi:20,simpson:[44,68],simul:23,simultan:11,sinc:[10,11,17,18,24],singl:[11,13,19,25,74,79,82,86],site:[],situat:[11,20,82],size:[2,4,11,15,25,44,68],skin:12,skip:10,slack:76,slot:[38,61],slow:11,slowlen:[],slowlog:[],small:85,smaller:[
11,15],smooth:11,snapshot:[],snarf:11,soa:[11,13,29,48],socket:[70,85],softwar:[],sole:85,solo:15,solr:16,solv:11,some:[3,8,10,11,13,15,25,82,85],some_crt:[31,50],some_csr:[31,50],some_kei:[31,50],somecdn:70,someth:[11,44,68],sometim:[3,11,44,68,76],soon:73,sort:11,sortat:5,sourc:[],sourcepass:15,sourceurl:15,sourceus:15,space:[10,13],spec:[17,20],special:[11,13,31,50,82],specif:[],specifi:[7,11,13,24,29,31,48,50,82],speed:[11,44,68],splunk:11,spread:[8,11],spring:70,sql:[9,10,11,16,25],sr2:[23,70],src:[8,23,69,70],ssh:[11,25],ssh_key_edge_us:9,ssl:[],sslkei:[16,31,48,50],sslkeyvers:50,stack:11,stage2:11,stage:[41,64],stale:8,standalon:16,standard:[8,11,23,70,73,83],start:[7,8,10,11,12,13,14,22,23,24,25,29,31,44,48,50,68,69,70,82,85],start_dat:[29,31,48],startdat:[46,51],starttim:[24,44,68],startup:[13,82],startupmincycl:7,stat:[],state:[7,10,11,13,23,24,25,31,34,40,50,57,63,70,71,74,82],statement:25,stateorprovinc:[44,68],static_rout:13,staticdnsentri:[],staticrout:[29,31,48,50],st
atist:[],statisti:11,stats_over_http:78,statsummari:24,statu:[],status:[],status_4xx:[51,87],status_5xx:[51,87],statustomon:15,stddev:31,stead:[11,17],steer:[],step:[2,8,10,13,16,20,70,74,85],still:[5,9,11,13,17,70,76,82],stop:[8,10,11,12],storag:[8,11,33,56,82],store:[1,2,6,10,11,15,16,18,25,40,63,73,83,87,88],straight:11,stream:[10,11],streamlin:8,street:[34,57],strict:[4,11],strictli:[4,82],string:[11,13,24,25,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,56,57,58,59,60,61,62,63,64,65,66,67,68,85],strip:10,struct:[38,61],structur:[],stylesheet:25,sub:[10,11],subdomain:13,subject:10,submit:[11,14],submodul:70,subnet:5,subroutin:10,subsequ:[18,25,85],subset:13,subtabl:11,succeed:10,success:[2,7,10,13,25,29,31,38,42,44,47,48,50,61,65,66,68],successfulli:[1,2,10,11,13,16,25,29,31,38,44,47,48,50,61,68],sudo:[7,10,12,13,14,15],suffic:16,suffici:11,suggest:[1,88],suitabl:[11,13,70],sum:[11,15,29,31,48],summar:87,summari:[],sun:[17,18,25],suppli:[8,1
1,18,25,38,61],support:[1,4,5,8,10,11,13,16,44,68,81],sure:[4,7,11,13,15,29,74],syn:11,sync:[11,14,15],sync_ful:[],sync_partial_err:[],sync_partial_ok:[],sync_ts_databas:15,syncd:[11,14],synchron:82,syntact:11,syntax:11,syslog_facil:9,sysmemtotals:[38,61],system:[],systemat:11,t_integr:25,tab:[8,11,15,24],tabl:[],tablet:[],tag:[11,46,51,87],taht:[11,31,50],take:[1,7,10,11,15,44,68,70,82,83],taken:[11,13,16],talk:0,tar:10,target:[6,10,11,13,15,25],targetpass:15,targeturl:15,targetus:15,tbd:[8,29,48],tc1_ats1:[50,61],tc1_ats2:61,tc_logo:[41,64],tcoveragezon:[29,48],tcp:[11,13,18,20,38,61,70],tcp_port:[],tcpport:[38,61],team:[1,31,50],technic:74,technolog:19,televis:85,tell:[8,17],temp:7,templat:[12,25],temporari:[25,40,63],temporarili:[69,85],tenant:[19,85],term:[73,87],termin:[10,70],test:[],testserv:70,text:[2,8,11,17,18,20,25,31,38,42,44,47,48,50,61,65,68],tgz:10,tha:25,than:[3,8,11,13,15,31,44,50,68,86],thei:[4,6,8,11,13,15,18,24,29,86,87,88],them:[11,13,15,29,73],themselv:8,there
bi:18,therefor:11,thi:[0,1,2,4,5,6,7,8,9,10,11,13,15,16,17,18,20,22,23,24,25,27,28,31,32,33,35,38,40,41,44,45,47,50,54,56,57,58,61,63,64,68,70,71,73,76,81,82,83,85],thing:[10,11,15],third:[5,76],thorough:55,those:11,though:[25,74,86],thousand:[3,11,19,79],thread:[7,13],threadpool:[7,11,29,48],three:[5,15,18,25,70,82,83,86,87],threshold:[8,29,48,82],through:[4,7,8,11,13,18,25,41,61,64,82,83,85,87],throughout:13,throughput:82,thu:[2,5,14],ticketnum:[30,49],tidi:25,tier:[0,8,11,31,41,50,64,74,78,86],time:[1,2,7,8,9,10,11,13,14,15,16,17,20,23,25,27,28,29,31,32,33,35,38,40,44,45,46,47,48,51,53,54,56,58,61,63,68,69,70,85],timefilt:15,timeout:[7,11,29,48],timepad:[7,29,48],timer:17,timestamp:[29,48],titl:15,tld:[1,11,13,29,48],tls_protocol:16,tlsv1:16,tm1:[8,10],tmhostnam:[7,11],tmp:[6,11,14],to_develop:25,to_extens:[],to_hom:[9,25],to_integr:25,to_pw:16,to_test:25,to_un:16,to_url:16,to_us:25,tocducheck:9,tochrcheck:9,todai:[18,19,79],todscpcheck:9,tofqdncheck:9,togeth:78,token:[],tom:[44,
68],tomcat:[7,13,23,70,82],tommyboi:[44,68],too:8,took:13,tool:[],toolnam:[8,41,64],tools_serv:11,toortcheck:9,top:[1,11,13,15,25,29,35,46,48,58],topasswd:15,topic:21,topingcheck:[9,25],tortrcheck:9,total:[11,13,25,29,31,48,50,51,87],total_commands_process:[],total_connect_attempt:11,total_connections_receiv:[],totalbyt:51,totalkbpsthreshold:[29,48],totalofflin:[29,31,48,50],totalonlin:[29,31,48,50],totaltpsthreshold:[29,48],totaltransact:51,tourl:15,touser:15,toward:11,tps_2xx:[31,51,87],tps_3xx:[31,51,87],tps_4xx:[31,51,87],tps_5xx:[31,51,87],tps_total:[51,87],tr1:[8,10],trace:14,track:[30,32,49,54],trademark:25,traffic:[],traffic_control:[23,25,69,70,73,74],traffic_lin:8,traffic_mon:7,traffic_mon_fwd_proxi:[8,41,64],traffic_monitor:[7,13,23,55,70],traffic_monitor_config:[7,23],traffic_monitor_host:70,traffic_op:[7,8,9,10,13,16,25,41,64,73],traffic_ops_:15,traffic_ops_cachegroup:15,traffic_ops_db:10,traffic_ops_devliveryservic:15,traffic_ops_extens:25,traffic_ops_ip:9,traffic_ops_
login:14,traffic_ops_ort:[14,25],traffic_ops_serv:15,traffic_ops_url:14,traffic_port:[12,69],traffic_portal_properti:12,traffic_rout:[13,70],traffic_router_api:70,traffic_router_connector:70,traffic_router_cor:70,traffic_rtr_fwd_proxi:[41,64],traffic_stat:[11,15,73],traffic_traffic_rout:70,trafficmonitor:[29,48],trafficop:[10,14],trafficopshost:[29,48],trafficopspath:[29,48],trafficopsus:[29,48],trafficopsvers:[29,48],trafficrout:[29,48],trafficrouterstart:70,trafficserv:[8,29,48],trafficstat:[25,51],traffop:[14,41,64],traiffic:11,tran:9,transact:[11,19,20,31,50,82,84,85],transaction_active_timeout_in:4,transfer:20,translat:11,transmiss:[25,38,61],treat:[11,17,24,31,50,86],tree:[],tri:[4,11,86],trigger:[11,13,70],trim:[28,34,35,43,47,57,58,67],trivial:3,troubleshoot:[],trrequesthead:50,trresponsehead:50,ttl:[8,11,13,20,29,31,39,44,48,50,53,62,68],ttm:[5,13],tue:85,turn:[4,74],tutori:3,twelv:[],two:[5,6,11,13,15,25,82,86,87],txt:[7,11],type:[],type_nam:[],typeid:[28,47],typenam:[28,4
7],typic:[8,11,15,19,20,44,68,73,86,87],udp:[13,70],uefi:[38,61],ugli:11,uichang:[30,49],uid:[44,68],unabl:13,unauthor:[25,44,68],unavail:[13,31,50,82],unavailableperc:[29,31,48,50],unawar:18,uncacheable_requests_bypass_par:11,uncommon:82,under:[],understand:[11,20,25],unfilt:7,uniqu:[4,11,17,27,28,30,31,32,44,45,47,49,50,53,54,68],unit:[9,10,11,23,25,31,38,50,61,70,73],unix:[8,11,29,31,48],unknown:[7,8],unless:[4,38,61,69],unlimit:8,unnecessari:[11,44,68],unquot:13,unsur:11,until:[11,20,70],unusu:13,uodat:11,upd:11,updat:[],update_riak_for_search:16,upgrad:[],upload:[],upon:[1,11,13,25,29,82],upstream:[11,13,82],uptime_in_dai:[],uptime_in_second:[],url:[],url_remap:11,url_sig:11,url_sig_:11,url_sig_kei:16,urlencod:25,urlhash:11,urlregex:5,usa:[31,50],usag:[11,14,19,25,29,48,83],uscsssfupsen:18,use_in_t:[31,50],use_ip_address:11,used_cpu_si:[],used_cpu_sys_children:[],used_cpu_us:[],used_cpu_user_children:[],used_memori:[],used_memory_human:[],used_memory_lua:[],used_memory_peak:[],
used_memory_peak_human:[],used_memory_rss:[],useint:[43,67],user:[],userid852:[30,49],userid853:[30,49],usernam:[7,10,13,14,16,23,44,68,88],userprofil:[44,68],usr:[7,15],usual:[8,10,11,14,17,20,25,41,44,64,68,78,82],utc:[14,41,64,87],utf:[17,18,20],util:[10,16,23,25,70,73],utilizedperc:[29,31,48,50],v11:31,v12:50,val:[32,54],valid:[5,11,13,16,17,46,51],valu:[4,5,7,8,10,11,13,15,16,23,24,25,29,31,32,33,38,44,46,48,50,51,54,56,61,68,70,82,83],variabl:[8,25,41,64,70],varieti:82,variou:[13,79],vast:[19,79],vault:[],vcpu:[7,10,13],verbatim:11,verbos:9,veri:[11,73,85],verifi:[7,10,11,13,18,23,70],version:[8,10,11,13,15,16,17,25,29,31,38,42,44,48,50,61,65,68,73,74,82],via:[2,6,7,11,13,15,18,25,70,85,88],video:[19,31,50,76,82],view:[],viewabl:83,vim:[8,16],vip:[4,11],virtual:20,visibl:[2,8,33,41,56,64],visit:11,visual_status_panel_1:15,visual_status_panel_2:15,vital:78,vod:13,wai:[11,13,14,15,19,25,79,83],wait:[10,11,14],wait_for_par:14,walk:25,want:[9,11,15,16,25,29,48,68,82],war:70,warm:2
5,warn:[2,7,14,25,31,38,42,44,47,48,50,61,65,68],watch:82,watcher:69,wbb:25,web:[2,8,11,14,23,69,70,83,84,85],webapp:[23,70],webbrows:11,webserv:78,websit:[11,15,16],wed:2,weight:[6,11,13],welcom:25,well:[0,11,13,15,25,82,87],were:[10,11,16,18,29,31,48,50],west:[8,86],what:[],whatev:11,when:[0,1,2,5,7,8,10,11,13,14,15,16,17,18,25,29,31,33,40,41,44,48,50,56,63,64,68,78,82,85],where:[8,9,11,15,25,74,85,86],whether:[4,11,13,18,24,48],which:[0,1,5,7,8,10,11,13,15,16,18,20,23,25,29,31,38,40,41,44,47,48,50,61,63,64,68,70,73,81,82,85,86,87],white:5,whitelist:[5,31,50],whitespac:10,who:[],whole:11,whose:[5,82],why:[],wikipedia:[18,78],wildcard:24,window:[2,11,24],wish:[0,10],within:[11,13,23,25,70,85],without:[5,8,11,13,20,74,82,85],woburn:[27,28,45,47],word:[3,25],work:[1,5,9,10,11,13,15,16,22,23,25,44,68,69,70,73,78],would:[17,25],write:[5,7,8,10,11,15,25,74,82],writt:11,written:[8,11,13,15,25,73,87],wrong:11,wrote:11,www:[7,10,13,17,18,20,25,85],x509:10,x520:[38,61],x86_64:10,xml:[5,11,1
6,31,33,44,50,56,68,70],xml_id:[13,29,31,48,50,87],xmlid:[29,31,44,48,50,68],xmpp:[40,63],xmpp_id:[],xmpp_passwd:[],xmppid:[38,61],xmpppasswd:[38,61],xpost:2,xput:[2,6,16],xxxyyi:6,xyz:[31,50],yesterdai:[29,48],yet:[2,11],yield:85,yml:25,you:[0,1,8,9,10,11,15,16,18,23,25,29,38,44,48,61,68,69,70,73,74,76,78,83],your:[1,7,8,9,10,11,12,13,15,16,25,29,31,48,50,69,73,74],yourcustomextens:25,yourself:[1,21],ys08:[38,61],yum:[7,10,12,13,16],zcf:78,zero:13,zip:[34,57],zone:[],zonemanag:11,zsk:[1,11,13,29,48],zskexpirationdai:[29,48]},titles:["API Routes","ASN","ASN","Administrator’s Guide","CDN","CDN","CDN Basics","Cache Control Headers and Revalidation","Cache Group","Cache Group","Cache Statistics","Caching Proxies","Change Logs","Change Logs","Configure DNSSEC","Configure Delivery Service Steering","Configure Federations","Configure Multi Site Origin","Configure Regional Geo-blocking (RGB)","Configuring Traffic Ops","Content Delivery Networks","Delivery Service","Delivery Service",
"Delivery Service Statistics","Developer’s Guide","Development","Divisions","FAQ","Federation","General","Glossary","HTTP 1.1","Hardware Info","Hardware Info","InfluxDB","Installing Traffic Ops","Introduction","Managing Traffic Ops Extensions","Parameter","Parameter","Physical Location","Physical Location","Profiles","Profiles","Quick How To Guides","Regions","Regions","Roles","Roles","Running a Traffic Control CDN","Server","Server","Snapshot CRConfig","Static DNS Entries","Static DNS Entries","Status","Status","System","System","TO Extensions","TO Extensions","Traffic Control","Traffic Control Overview","Traffic Monitor","Traffic Monitor","Traffic Monitor APIs","Traffic Monitor Administration","Traffic Ops","Traffic Ops","Traffic Portal","Traffic Portal","Traffic Portal Administration","Traffic Router","Traffic Router","Traffic Router API","Traffic Router Administration","Traffic Server","Traffic Server","Traffic Server Administration","Traffic Stats","Traffic Stats","Traffi
c Stats Administration","Traffic Vault","Traffic Vault Administration","Types","Types","Users","Users","Using Traffic Ops"],titleterms:{"case":[23,25,70,73],"static":[11,39,62],admin:16,administr:[0,7,12,13,14,15,16,79],alwai:13,api:[23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,56,57,58,59,60,61,62,63,64,65,66,67,68,70,71],arrow:[18,82,83,85,86],asn:[11,27,45],assign:11,authent:11,base:11,basic:[21,79],becom:75,block:5,bulk:11,cach:[8,17,18,28,46,47,82,86],cache_stat:46,cachegroup:[28,47],can:75,ccr:[11,76],cdn:[21,25,29,48,74,79],cdn_name:66,cento:8,cert:8,chang:[30,49],check:[11,25],configur:[1,2,4,5,6,7,8,13,14,15,16,25],content:[8,11,19,85],control:[17,74,76,79,80],convent:[23,25,70,73],coverag:11,crconfig:[11,66,74],creat:8,cron:9,daili:11,data:25,databas:25,deliveri:[6,8,11,19,31,50,51,85],deliveryservic:[31,50],deliveryservice_stat:51,develop:[22,23,25,69,70,73,75,79],directori:25,divis:52,dnssec:[1,11,13,29,48],domain:[29,48
],dscp:11,endpoint:25,entri:[11,39,62],environ:[23,25,69,70,73],error:25,event:13,exampl:[9,25],extens:[9,25,42,65,83],failur:13,faq:[77,79],featur:13,feder:[2,11,53],field:13,file:[7,8,9,11,13,16],format:[13,23,25,70,73],forward:18,gener:[11,76],geo:5,geolimit:13,get:76,glossari:78,graph:11,group:[8,28,47,86],guid:[0,3,22,79],hardwar:[32,54],header:[11,17],health:[11,29,31,48,50,82],help:76,how:[3,75,76],http:[13,20,85],hwinfo:[32,54],indic:79,influxdb:[15,55],info:[32,54],instal:[7,8,10,13,14,15,16,23,25,69,70,73],introduct:[23,25,69,70,73,81],invalid:11,involv:75,iso:11,java:[23,70],json:74,kabletown:25,kei:[11,13,29,31,48,50],kickstart:8,licens:76,local:85,locat:[8,34,57],log:[7,13,30,49],manag:[9,11,25],menu:11,messag:13,metric:[29,31,48],monitor:[7,23,24,82],monkei:76,multi:[4,11],name:25,navig:10,network:[8,19],note:69,oper:13,option:11,origin:[4,11],overview:[7,13,23,25,69,70,73,79,80],packag:[25,70],paramet:[8,11,33,56],parent:11,perl:25,phys_loc:[34,57],physic:[34,57],port
al:[12,69,84],present:13,profil:[8,11,35,58,86],project:[23,25,69,70,73],protocol:82,proxi:18,purg:8,queue:11,quick:3,rascal:76,redi:[],redirect:13,refer:25,regexp:11,region:[5,8,36,59],reject:74,releas:76,requir:[10,23,25,69,70,73],respons:25,revalid:17,revers:18,rewrit:11,rgb:5,riak:16,role:[37,60],roll:13,rout:[25,26,29,48,85],router:[11,13,70,71,85],rpm:70,run:74,runtim:25,sampl:13,search:16,select:11,server:[11,14,31,38,50,61,72,86],servic:[6,11,31,50,51,85],sig:11,sign:13,site:[4,11],snapshot:[11,66],softwar:[23,25,69,70,73],sourc:25,specif:13,ssl:[8,31,48,50],stat:[15,73,87],staticdnsentri:[39,62],statist:[46,51],statu:[40,63],status:[40,63],steer:[6,13],structur:25,summari:[11,13],system:[10,41,64],tabl:[11,79],test:[23,25,70,73],to_extens:[42,65],token:11,tool:[11,15],topolog:[29,48],traffic:[7,8,9,10,11,12,13,14,15,16,23,24,25,69,70,71,72,73,74,76,79,80,82,83,84,85,86,87,88],trafficopsrout:25,transpar:18,tree:[23,25,69,70,73],troubleshoot:[7,13],twelv:76,type:[11,43,67],un
der:76,updat:11,upgrad:10,upload:11,url:11,user:[44,68],vault:[16,88],view:11,what:76,who:76,why:74,zone:[11,13]}})
\ No newline at end of file
+Search.setIndex({envversion:48,filenames:["admin/index","admin/quick_howto/dnssec","admin/quick_howto/federations","admin/quick_howto/index","admin/quick_howto/multi_site","admin/quick_howto/regionalgeo","admin/quick_howto/steering","admin/traffic_monitor","admin/traffic_ops_config","admin/traffic_ops_extensions","admin/traffic_ops_install","admin/traffic_ops_using","admin/traffic_portal","admin/traffic_router","admin/traffic_server","admin/traffic_stats","admin/traffic_vault","basics/cache_revalidation","basics/caching_proxies","basics/content_delivery_networks","basics/http_11","basics/index","development/index","development/traffic_monitor","development/traffic_monitor/traffic_monitor_api","development/traffic_ops","development/traffic_ops_api/routes","development/traffic_ops_api/v11/asn","development/traffic_ops_api/v11/cachegroup","development/traffic_ops_api/v11/cdn","development/traffic_ops_api/v11/changelog","development/traffic_ops_api/v11/deliveryservice","development/traf
fic_ops_api/v11/hwinfo","development/traffic_ops_api/v11/parameter","development/traffic_ops_api/v11/phys_location","development/traffic_ops_api/v11/profile","development/traffic_ops_api/v11/region","development/traffic_ops_api/v11/role","development/traffic_ops_api/v11/server","development/traffic_ops_api/v11/static_dns","development/traffic_ops_api/v11/status","development/traffic_ops_api/v11/system","development/traffic_ops_api/v11/to_extension","development/traffic_ops_api/v11/type","development/traffic_ops_api/v11/user","development/traffic_ops_api/v12/asn","development/traffic_ops_api/v12/cache_stats","development/traffic_ops_api/v12/cachegroup","development/traffic_ops_api/v12/cdn","development/traffic_ops_api/v12/changelog","development/traffic_ops_api/v12/deliveryservice","development/traffic_ops_api/v12/deliveryservice_stats","development/traffic_ops_api/v12/division","development/traffic_ops_api/v12/federation","development/traffic_ops_api/v12/hwinfo","development/traffic
_ops_api/v12/influxdb","development/traffic_ops_api/v12/parameter","development/traffic_ops_api/v12/phys_location","development/traffic_ops_api/v12/profile","development/traffic_ops_api/v12/profile_parameter","development/traffic_ops_api/v12/region","development/traffic_ops_api/v12/role","development/traffic_ops_api/v12/server","development/traffic_ops_api/v12/static_dns","development/traffic_ops_api/v12/status","development/traffic_ops_api/v12/system","development/traffic_ops_api/v12/to_extension","development/traffic_ops_api/v12/topology","development/traffic_ops_api/v12/type","development/traffic_ops_api/v12/user","development/traffic_portal","development/traffic_router","development/traffic_router/traffic_router_api","development/traffic_server","development/traffic_stats","faq/administration","faq/development","faq/general","faq/index","glossary","index","overview/index","overview/introduction","overview/traffic_monitor","overview/traffic_ops","overview/traffic_portal","overvie
w/traffic_router","overview/traffic_server","overview/traffic_stats","overview/traffic_vault"],objects:{},objnames:{},objtypes:{},terms:{"00z":[46,51],"03m":10,"06b4f870d809d82a91433e92eae8320875c3e8b0":2,"0x10001":10,"10g":[9,11,25,38,42,62,66],"10g6":[9,11,25],"10g_ping":[42,66],"10gbp":8,"10t22":46,"11t11":51,"11t12":[46,51],"12m":[40,64],"12t12":[46,51],"17m":10,"1aa008f":[17,18],"1b08977e91f8f68b0ff5d5e5f6481c76ddfd0853":25,"1gb":8,"1min":15,"200mb":13,"20141222103718_extens":[10,25],"20150108100000_add_job_deliveryservic":[10,25],"20150205100000_cg_locat":[10,25],"20150209100000_cran_to_asn":[10,25],"20150210100000_ds_keyinfo":[10,25],"20150304100000_add_ip6_ds_rout":10,"20150310100000_add_bg_fetch":10,"20150316100000_move_hdr_rw":10,"24h":15,"2gb":13,"2xx":83,"32gb":10,"3rd":[29,31,34,48,50,57],"3xx":83,"4217a5":[38,62],"4xx":83,"50a3559482cc0":[17,18],"50aa00feadd":17,"567a":11,"567b":11,"56h":[44,69],"5gbp":8,"5thpercentil":[29,31,48],"73be":10,"8a5a61b91473bc785d4073fe711d
e8d2c63f02dd":25,"8d65":10,"8gb":[7,13],"95thpercentil":[29,31,48],"98thpercentil":[29,31,48],"9rd":[34,57],"__cache_ipv4__":11,"__hostname__":[33,56],"__return__":[4,11],"_before_":11,"_osvers":11,"boolean":[24,25,29,31,33,44,48,50,56,69],"byte":[11,25,83,88],"case":[5,11,13,15,17,18,19,20,22],"class":[10,13,25,71,85],"default":[1,4,7,8,10,11,13,14,15,16,17,18,20,25,33,38,50,56,59,62,70,71,84,88],"delete":[2,25,47,48,50,53,56,58,59,62],"export":[8,11,15,25,87],"final":[8,13],"float":[46,51],"function":[10,11,13,18,20,25,70,79,80,84,85,86,88],"import":[8,11,13,20,23,71,86,87],"int":[11,24,29,30,31,34,36,38,44,45,46,47,48,50,51,52,53,57,60,62,69],"long":[8,10,11,13,17,20,44,69],"new":[1,4,5,8,11,13,15,16,17,29,36,44,53,58,60,69,83,85],"null":[9,28,29,30,31,38,42,44,47,48,49,50,51,62,66,69],"public":[8,10,12,13,15,25,29,41,48,65,89],"return":[11,13,16,24,25,29,31,46,48,59,74,86],"short":[11,13,34,40,57,64,74,83,88],"static":0,"super":16,"switch":11,"true":[1,2,7,11,15,25,29,31,33,44,4
8,50,55,56,69],"try":[8,10,11,13,25,44,69],"var":[7,9,10,13,23,71],"while":[4,11,13,15,19,20,25,71],a00:[38,62],a_record:[43,68],aaaa:[11,13,29,31,43,48,50,68,71],aaaa_record:[43,68],aadata:55,abbreviat:[28,47],abc123def456:48,abil:[2,13,25],abiliti:85,abl:[5,11,13],about:[8,10,11,13,15,18,24,30,31,32,41,46,49,50,54,65,74,86,88],abov:[1,10,12,13,15,17,70,71,74,79,83],absolut:15,accept:[2,13,25,56,59,75],access:[2,5,7,8,10,11,13,15,16,25,31,33,38,50,56,59,62,70,71,74,84,89],accesscontrolalloworigin:7,accord:[11,44,69],accordingli:4,account:[25,83],accur:[7,12,13],achiev:15,ack:11,acl:[31,50],acquir:[74,88],acronym:13,across:[4,8,11,13,19,29,31,48,50],act:[11,18,79],action:[2,11,18,31,47,50,62],activ:[1,8,11,13,31,41,44,50,65,69,88],activat:11,active:11,active_directory:[43,68],actual:[8,11,18,83,86],adapter:[38,62],add:[1,2,5,8,10,11,13,14,15,16,17,23,25,31,50,53,71,75,83,84,89],adding:10,addit:[10,13,20,25,50,79,83],addition:[11,31,50],additional:2,additional_config_json:[42,66],add
ress:[4,7,8,9,10,11,13,18,20,25,31,34,38,39,44,50,53,57,62,63,69,71,72,75,86],addressline1:[44,69],addressline2:[44,69],adher:[40,64],adjust:[9,13],admin:[0,1,2,7,10,11,13,14,15],admin_down:[38,40,62,64,83],administ:13,adminpassword:16,adminstr:8,advanc:11,affect:83,affili:25,after:[2,8,10,11,13,18,20,23,25,71,75,84],afterward:4,again:[10,17,25,83],against:[5,11,13,16,25,83],age:18,agent:[25,44,69],aggreg:[19,29,48,83],agre:83,aid:11,albuquerqu:[34,57],alert:[2,25,31,34,36,38,42,44,45,47,48,50,52,56,57,58,59,60,62,66,69],algorithm:[4,11,48],alias1:[31,50],alias2:[31,50],alias:[31,50],aliv:[2,25],all:[2,4,5,7,8,11,13,14,15,16,18,19,24,25,29,31,41,44,47,48,50,52,53,55,65,69,74,75,77,79,82,83,84,85,86,87,88],all_graph_url:15,allow:[1,2,5,7,8,11,13,15,17,19,24,25,31,45,48,50,53,58,62,71,74,75,79,83,84,86,87,89],allow_ip6:8,allow_ip:8,almost:11,along:[15,16,25],alongsid:4,alreadi:[11,14,16,18,31,50,59,86],also:[0,8,11,13,16,17,25,31,50,51,74,77,79,83,84,86],alter:[31,50],altern:[5,50],al
though:[10,82],alwai:[0,11],amount:[7,8,11,13,44,69],anaconda:[8,11],analysi:[19,82],angularjs:[70,85],ani:[4,5,8,10,11,13,15,16,25,30,41,49,56,65,74,83],anonym:15,anoth:[10,11,13,15,23,71,74,83],another:13,answer:[2,10,11,13],any:[2,6,11,13,31,50],any_map:11,anyth:[11,32,54],anywai:11,anywher:[11,13],apach:[0,16,17,18,73,82,83,86,87],apachetrafficserv:18,api:[2,6,11,13,16,22],apichange:[30,49],apiport:[29,48],apnic:[27,45],app:[8,9,10,16,25,41,65,70],appear:[11,18],appli:[4,8,11,25,31,43,50,68,79,87],applic:[2,5,8,10,11,14,16,22,23,25,38,44,62,69,70,71,83,84],applicat:13,applicationcontext:71,applicationproperti:71,approach:[1,25,83],appropri:[4,8,11,13],apr:[10,25],april:82,architectur:[80,81,82],archive:10,area:[5,19,25],aren:29,argument:25,around:[13,86,88],arrai:[15,25,27,28,29,31,35,38,42,44,45,46,47,48,50,51,53,55,56,58,59,62,66,69],articl:79,artifact:71,asap:[11,44,69],ascii:8,asdasdasdasfasg:13,ashburn:[34,57],ask:[10,14,17,25,83],asn:0,asnsjj:25,aspect:71,asset:[12,13,83],
assettyp:[44,69],asseturl:[44,69],assgin:11,assign:[2,4,5,6,8,11,13,15,25,31,38,47,50,59,62,75,87],assignment:[0,6],assist:8,associ:[11,29,31,48,50,53,56,59,85],associat:[13,16,59],assum:[10,11,15,70,75],assume:18,assumpt:7,assumption:16,astat:[8,25,79,83],astats_over_http:8,ater:10,atl:55,atlanta:[36,47,55,60],ats:[8,11,13,18,25,44,69,79,82,83,87],atsec:[13,30,38,41,47,49,55,62,65,86],atsmid:[32,54],attempt:[11,14,18,86],attribut:[5,10],audio:19,auger:77,auth:[7,11,25,31,50],authent:[0,7,10],author:[10,11,13,16,25],authorit:[10,13,20,86],authority:2,auto:[13,71],autoconf:10,autofil:11,autom:[13,74],automak:10,automat:[9,10],autonom:[11,27,45],avail:[2,7,8,11,13,15,19,23,25,26,28,29,31,40,44,47,48,50,64,69,71,80,83],availabilti:15,availabl:86,availablebandwidthinkbp:[8,29,48],availableperc:[29,31,48,50],avali:10,averag:[8,46,51,83],avoid:[1,5,13],awai:11,await:10,awar:[11,18,87],b3ff:53,b42be0749415cefd1d14e1a91bb214845b4de556:2,back:[4,17,25,44,69,83,86],background_fetch:[11,31,50]
,backlog:13,backplane:[38,62],backup:[4,11],backward:13,bad:8,badass:14,balanc:13,bandwidth:[8,11,15,31,46,50,85,86,88],bar:[15,17,18,20,29,31,33,39,42,48,50,56,63,66,86],base64:[31,48,50],base64encodedcrt1:48,base64encodedcrt2:48,base64encodedkey1:48,base64encodedkey2:48,base:[0,3,4,6,8,10],base_url:[9,25],bash:[9,11,12],basi:[13,74,86,88],basic:20,baz:[31,39,50,63],bbt:25,bcm5720:[38,62],becaus:[5,8,86],becom:1,been:[1,2,8,10,11,13,15,16,23,71,83],befor:[1,7,8,10,11,14,29,69,75,84],begin:[7,10,46,51,83,86],behalf:18,behavior:[13,83],belong:[31,34,36,38,45,50,57,60,62],below:[8,9,11,13,14,15,18,20,21,24,25,82,83,86,87],best:[10,11,13,15,75,86],beta:[11,25],better:[10,84,86],between:[4,7,9,11,13,14,15,25,74,79,83,84,86,87],bin:[7,9,10,11,23,25],binari:[0,13],bind:71,bios:[38,62],bit:[10,11],blacked_out:5,blacklist:25,blank:[8,10,11,15],block:[0,3],blue:82,blurb:8,bodi:[6,17,18,20],bond0:[11,38,62],bond:11,boo:[31,50],bool:[29,31,38,48,50,62],boot:8,bootabl:11,bootproto:11,bootstrap:
[7,13,25,71],bot:11,both:[4,6,10,11,13,18,19,25,31,50,56,59,71,83],bottom:[11,14,15,16],bower:70,box:[4,13,82],bp12g:[38,62],bracket:[11,13],brave:11,breach:11,brief:15,broadcom:[38,62],brought:15,brows:[23,71],browser:[2,7,23,25,84],bucket:16,bug:[30,49],build:[8,10,11,12,15,23,25,71,74],built:71,bulk:0,bunch:11,bundl:[13,16,87],busi:[31,50,83],businessunit:[31,50],button:[1,2,6,11,15],bypass:[11,13,31,50],bypassdestin:[29,48],c0a8:13,cabl:77,cacertfil:16,cach:[0,2,4,5,7],cache01:18,cache_group_edg:[47,62],cache_group_mid:47,cache_range_request:[11,31,50],cache_stat:[15,26],cachegroup:[4,11,26,27],cachegroup_graph_url:15,cachegroupid:[38,45,47,62],cachegroupnam:47,cachegroupparamet:[28,47],cacheretentionpolici:15,cachestat:24,cacheurl:[11,31,50],calcul:[7,11,74],call:[7,9,10,11,13,15,25,77,83,86],callahan:[44,69],can:[1,2,4,6,8,9,10,11,13,14,15,16,17,18,20,23,25,31,41,44,50,56,65,69,71],canadian:5,cannot:[31,50,69],capac:[11,29,31,48,50,83,85],care:[11,13,15,44,69,84],carri:86,cart
on:25,catalina:13,catalina_base:7,catalina_home:7,catalina_pid:7,catalina_tmpdir:7,categori:[30,49],caus:[11,44,69,83],caution:11,cb00:10,ccp:53,ccr1:[58,59],ccr:[0,5],ccr_cdn1:50,ccr_cdn:50,ccr_copy:58,ccr_ignore:[40,64],ccr_top:[35,58],ccr_update:58,ccrdnsttl:[31,50],ccsi:18,cdn1:[10,11,29,48],cdn2:[29,48],cdn:[0,1,2,4,5,6,7,8,10,11,13,14,15,16,17,18,19,20],cdn_eng:[31,50],cdn_name:[11,29,48],cdn_number_1:[47,50,62],cdn_test2:48,cdn_test:48,cdnid:[31,38,50,62],cdnlab:[13,41,65],cdnname:[7,11,23,29,31,38,46,48,50,62],cdu:[9,11,25],cen:[32,54],cent6:5,cento:11,centos65:[8,10],centos:[0,7],central:[19,52],cert:0,certain:[24,25,71,89],certainli:11,certfil:16,certif:[0,8,10],cfg:[8,11,15],cfg_:11,cg_edg:47,chain:0,challeng:10,chang:[2,8,11,13,14,15,16,17,18,20,23,25],changeabl:14,changelog:11,channel:77,charact:[5,13],charset:[17,18,20],chart:[70,85,88],check:[0,4,8,9],check_extension_bool:[25,42,66],check_extension_num:25,check_nam:9,checkpath:[31,50],chi:[5,13,38,47,62,87],chicago:[2
8,38,47,62],child:[4,11,47],choic:13,choos:[1,2,11,15],chosen:[1,5,11,82],chr:[9,11,25],cidr:[5,8],cisco:77,citi:[10,13,31,34,44,50,57,69],clarif:[13,20],classless:5,classpath:7,clean:[23,71],clear:25,cli:70,click:[1,2,4,5,6,11,13,14,15],clickabl:11,client:[2,5,11,13,17,18,20,29,31,40,48,50,64,70,71,74,79,83,85,86,87],client_connect:88,clone:[16,23,25,70,71,74],cloog:10,close:[2,11,17,18,83],closest:[71,79,86],cluster:[15,16,87],cmc:[28,47],cmd:2,cms_interfac:9,cname:[2,11,13,50,53],cname_record:[39,63],cnames:11,code:[5,10,11,13,23,25,31,40,50,64,71,74],codebas:[23,71],codepoint:25,coexist:86,collect:[8,15,23,25,27,28,29,31,38,41,42,44,45,47,48,50,56,58,59,62,65,66,69,84],collis:25,colorado:[31,50],column:[9,11,25,46,51],com:[5,10,11,12,13,15,17,18,20,23,25,29,31,34,42,44,48,50,57,62,66,69,71,75,86],combin:[79,86,87],comcast:[11,13,23,71,75,77,82],come:[11,17,25,31,50],comma:[8,11,24],comman:11,command:[1,10,13,16,25],comment:[8,12,34,41,57,65],common:[0,10,20,25,83,86],commonli:[1
7,23,25,70,71,74],commun:[13,18,25,71,77,87],compani:[10,14,44,69],compar:11,comparison:[8,87],compass:70,compat:[11,44,69],compil:[10,25],complet:[0,7,10,11,13,14,20,25,71],complianc:18,complic:[3,83],compon:[11,13,15,80,81,82,83,84],comprehens:[10,20],compris:71,comput:15,computation:13,concaten:[11,25],concept:[21,86],concurr:[13,77],cond:4,condit:[11,13,44,69],conf:[7,10,11,12,13,15,16,23,25,70,71],config:[4,5,7,8,10,11,12,13,14,15,16,25,29,33,40,48,56,64,70],config_fil:[11,29,33,48,56,59],configdoc:24,configfil:[56,59],configfile1:[56,59],configfile2:[56,59],configur:0,confirm:[8,11],conjunct:[11,83],connect:[2,7,10,11,13,14,15,17,18,19,20,25,29,48,83,86],connect_attempts_max_retri:4,connect_attempts_max_retries_dead_serv:4,connect_attempts_timeout:[4,11],connector:71,consequ:71,consid:[4,8,31,50,83,86,87],consist:[4,11,13,15,19,71,79,83,84,86],consistent_hash:11,consol:[23,71],construct:11,consult:15,consum:[11,19,22,24,25,70,83,85],contact:[25,34,57],contain:[8,11,13,20,23,70
,71,74,87,88],content:[0,2,4,5],contenttyp:[31,50],context:18,continu:[10,15,20,74,75],contribut:25,contributing:76,control:[0,1,2,3,7,8,10,11,12,13,15],conveni:71,convent:22,convers:11,convert:[8,13],cooki:[2,6,16,25,44,69],cookie:16,cool:[31,50],coordin:[8,29,48,86,87],copi:[10,11,12,13,15,58],copyright:25,core:[11,71],corpor:[25,31,50],correct:[7,10,11,13,15,16,25],correctli:[10,11,13,15],cost:86,could:[8,11,13],count:[7,24,29,31,38,46,48,51,62],counter:83,countri:[10,31,44,50,69],coupl:[13,16],coverag:[0,10],coveragezon:[10,11,29,48],coveragezonejsonurl:11,coveragezoneonli:[29,48],cox:77,coyot:86,cpan:[10,25],cpanfil:25,cpld:[38,62],cpp:10,cpu:13,cqhm:[5,13],cqhv:[5,13],cr_bar:[29,48],cr_foo:[29,48],cran:26,crconfig:[0,1,5,7,8],creat:[0,2,4,6],create_network_lin:11,create_ts_databas:15,creation:[10,48],credenti:[2,13,25],critic:[13,83],cron:0,cronjob:25,crontab:[9,14],cross:[30,49],crossdomain:[11,31,50],crstate:[7,24],crt:[10,13,16,31,48,50,89],cryptograph:[13,48],csr:[10,31,50
,89],css:[12,25],csv:11,cti:25,curl:[2,6,7,10,12,13,16,25],current:[1,5,7,9,10,11,13,16,24,25,30,44,49,69,72,74,82,88],current_client_connect:[11,46,88],currentgbp:[29,48],custom:[10,11,12,15,25,31,50,74,83,84],customiz:84,cycl:[7,13],czf:[11,13,31,50],czm:79,czmap:13,d0d0:[38,62],d1s2:[38,62],d1s4:[32,54],d6xpdv1:[38,62],d903:[38,62],dai:[1,8,11,14,15,20,29,30,48,49,69,74,88],daili:0,daily_bw_url:[11,15],daily_served_url:[11,15],daily_stat:[15,88],dailysummarypollinginterv:15,dailysummaryretentionpolici:15,danc:13,dash:[5,13],dashboard:[15,74],data:[10,11,13,15,16,17,24],databas:[5,8,9,10,11,13,15,16,22],datacran:26,datadeliveryservic:26,datadeliveryserviceserv:26,datadomain:26,datahwinfo:26,datalink:26,dataloc:26,datalocationparamet:26,datalog:26,dataparamet:26,dataphys_loc:26,dataprofil:26,dataregion:26,datarol:26,dataserv:[26,29,48],dataserverdetail:26,datastaticdnsentri:26,datastatu:26,datatyp:26,dataus:26,date:[1,2,11,13,14,17,18,25,27,28,29,32,33,35,38,40,44,45,46,47,48,51,54
,56,58,62,64,69,86],dbconf:25,dbix:[10,25],dcchi:[28,47],deactiv:11,dead:11,dead_server_retry_en:[4,11],dead_server_retry_response_cod:[4,11],deal:83,debug:[2,7,11,14],dec:[2,17,18],decim:13,decis:[71,86],decreas:13,defin:[4,5,8,11,13,25,71,87],degre:13,del:[31,50],delai:[7,71],deleg:[10,13],delet:[2,8,11,16,17,25,29,31,42,47,48,50,53,56,58,59,62,66],delimit:[11,71],deliv:[11,19,77,86],deliveri:[0,1,2,3,4,5],deliveryprotocol:[31,50],deliveryservic:[2,5,6,7,11,14,15,16,24,26,29],deliveryservice_graph_url:15,deliveryservice_stat:[15,26],deliveryserviceid:5,deliveryservicenam:51,deliveryserviceserv:[26,31,50],dell:[38,62],demand:[13,31,50],den:87,deni:[5,50],denial:13,denver:[8,10,29,31,36,39,48,50,60,63],depend:[1,10,11,13,25,70,74],dependeci:10,deploi:[8,14,19,41,65,71,80,83,87],deploy:[10,13,71],deprec:[38,62],depth:8,dequeu:[47,62],deriv:[11,13],describ:[11,13,18,31,41,50,53,65],descript:[4,7,8,10,11,13,15,24,25,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,5
0,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69],design:[70,84,85],desir:[6,13,31,50,51,86],destin:[11,13,19,31,50,80,83],detail:[0,8,11,13,20,25,26,30,31,38,45,47,48,49,50,62],detect:83,deteremin:11,determin:[11,13,25,71,79,83,84,86],dev:[9,15],devel:10,develop:[0,10,15],devic:[11,79],dhcp:11,diag:11,diagnost:[38,62],diagram:82,did:[13,17],diff:[5,11,75],differ:[4,8,10,11,13,14,15,16,18,20,83,84,87,88],differenti:[31,50],diffserv:25,dig:[1,2,13],digest:[10,48],digesttyp:48,dilig:13,dimens:83,dir:[10,13],direct:[18,79,87],directli:[11,13,16,18,79],directori:[8,10,11,15,23],disabl:[13,48,50],disallow:5,disclaim:14,discuss:86,disk:[7,8,10,11,25,32,38,54,62,86],dispers:[14,50],displai:[2,9,11,15,23,24,31,38,50,62,71,88],displaynam:[31,50],disregard:7,dist:70,distanc:[86,87],distinguish:[4,10],distribut:[0,8,10,13,19,71,77,80,86],divers:83,divert:11,divis:[8,11,25,36],division_nam:[36,60],divisionid:[36,60],divisionnam:[36,60],divsionid:[36,60],dns:[0,1,7,9,10],dns_live:11,dn
s_live_national:11,dns_live_natnl:11,dnsbypasscnam:[31,50],dnsbypassip6:[31,50],dnsbypassip:[31,50],dnsbypassttl:[31,50],dnskey:[11,13,48],dnssec:0,dnssecenabl:[29,45,48],dnsseckei:[11,29,48],document:[3,11,13,15,16,18,25,55,73,77,80,83,87],doe:[4,7,8,11,13,18,20,25,31,34,50,57,59,79,86,87,88],doesn:[11,13,17,25],doesssss:[34,57],domain:[1,5,10,11,13,25,26],domain_nam:[11,25,29,33,48,56],domainnam:[9,10,29,38,48,62],don:[8,11,25,29,75],done:[2,11,13,16,70,75],doubl:13,down:[4,7,11,25,31,40,50,64,86],download:[7,10,11,12,15,16,23,71],downsampl:[15,74],downstream:[11,17,31,50],drill:11,drive:[11,74,88],drive_config:11,drive_lett:[8,33,56],drive_prefix:8,driver:[38,62],drop:[4,10,11,25,31,50,83],dropdown:15,ds1:48,ds2:48,ds_1:50,ds_bypass:13,ds_client_geo_unsupported:13,ds_cz_only:13,ds_miss:13,ds_no_bypass:13,ds_not_found:13,ds_redirect:13,dscp:[0,9],dsid:[38,44,62,69],dsname:86,dsr:[29,31,48,50],dsrecord:48,dsretentionpolici:15,dsstat:24,dsxmlid:[44,69],due:[11,31,50,83],dummi:75,dum
myxmpp:[38,62],dump:11,duplic:[8,87],durat:11,dure:[8,11,13,14,23,25,71],dynam:11,each:[0,4,7,8,9,10,11,13,15,16,24,25,29,30,31,47,48,49,50,82,83,86,87],earth:79,easi:11,easier:[8,25,71],easili:15,east:[34,57,87],echo:11,eclips:[23,71],econom:[19,80],edg:[1,2,11,13,29,31,40,47,48,50,64,71,75,79,86,88],edge1:[8,10],edge1_cdn1_421:62,edge1_cdn1_421_ssl:[38,62],edge1_top_421_pspp:55,edge:[0,4,8,10,11,18,25,31,38,40,42,50,62,64,66,75,83,86,87,88],edge_loc:47,edgeheaderrewrit:[31,50],edit:[2,7,8,9,11,13,15,23,25,41,45,47,48,50,56,58,62,65],editor:8,effect:[1,5,11,13,16],effectiv:[1,11],effici:[31,50],either:[11,13,16,86],el6:2,element:5,elig:86,els:[13,15],email1:[44,69],email:[10,11,31,34,44,50,57,69],emailto:[31,50],embed:[23,25,71],empti:[5,13,58],enabl:[1,4,5,11,13,16,29,31,45,48,50],enclos:13,encod:[29,31,48,50],encompass:19,end:[11,13,18,19,24,25,29,31,46,48,51,79,86],end_dat:[29,31,48],enddat:[46,51],endpoint:[7,16],endtim:24,enform:10,engineer:[31,50],enhanc:[25,84],ensur:[7,8,11
,12,13,19,83],ensure:[13,23,71],enter:[1,7,8,10,11,13,15,25,31,38,50,62,75],entere:[11,44,69],enteredtim:[44,69],enterpris:[8,15,38,62],entir:[13,18],entri:[0,1,4],entry:[11,31,50],env:25,enviro:25,environ:[8,10,11,15,16,22],epoch:[11,13,24,29,48],equal:[5,13,56,59],equival:[40,64],err:[29,31,48,50],error:[1,10,11,13,14,18,23],especi:86,especial:[10,75],essenti:20,establish:13,etag:[17,18],etc:[9,10,11,12,16,23,25,71,74,83,84],eth0:[9,62],eth4:11,ethernet:[11,38,62],evalu:[11,83],even:[19,25,75,80,84,87],event:[0,4,7],eventlog:24,eventu:[23,71],everi:[11,13,14,19],everyth:[0,11,16],examp:[56,59],exampl:[0,2,4,5,6,8],exampleurl:[31,50],exce:83,exceed:[11,31,50,83],except:[4,11,13,82,86],exclud:[5,11,86],excludepostalcod:5,exclus:5,execut:[8,10,23,25,71],exist:[5,7,11,13,23,24,25,29,56,58,59,71],exit:[7,14],exp:[38,62],expand:[23,71],expat:10,expect:[10,11,13],expens:[11,44,69],experi:13,experienc:11,experiment:[11,13],expir:[1,2,11,13,17,25,29,48],expirat:[1,11,29,48],expirationd:[29
,48],expire:[11,17,44,69],explain:[16,82],explainat:11,explainatori:11,explanat:10,explicit:18,explicitli:[17,83,84],explor:[23,71],expos:[84,88],expres:11,express:[8,11,13,44,69,70],expression:11,extend:[5,79],extens:[9,11,13,22,25,42,66,79,84],extension:0,extensioncheck:9,extensionnam:25,extern:80,extra:10,extrem:[13,83],eyjhdxrox2rhdgeioijhzg1pbiisimv4cglyzxmioje0mjk0mdqzmdz9:25,eyjlehbpcmvzijoxndi5ndaymjaxlcjhdxrox2rhdgeioijhzg1pbij9:25,eyjlehbpcmvzijoxndi5ndazodyzlcjhdxrox2rhdgeioijhzg1pbij9:25,eyjlehbpcmvzijoxndq5mta1mti2lcjhdxrox2rhdgeioijmzwrlcmf0aw9ux3vzzxixin0:2,eyjlehbpcmvzijoxndq5mta1otqylcjhdxrox2rhdgeioijmzwrlcmf0aw9ux3vzzxixin0:2,f990d03b7180b1ece97c3bb5ca69803cd6a79862:25,fact:[8,11,83,87],factor:[4,86],fail:[4,5,11,13,25,59,83],fail_threshold:11,failov:[4,11,31,50],failur:[0,11],fairli:11,fall:86,fallback:5,fals:[7,11,13,29,31,33,38,44,48,50,56,62,69,83],familiar:21,fast:83,fatal:14,fe1e:53,fe80:53,featur:[0,3,4,5,11],fed:[13,50],fedeat:2,feder:0,federation_user1:2,
feedback:13,fetch:[5,11,13,14,56],few:10,ffff:13,field:[0,5,9,10,11],fifthpercentil:[46,51],file:[0,5],filenam:11,fill:[5,8,11,77],filter:[6,13,38,43,58,62,68],find:[11,13,18,23,71,79,86],finish:[23,71,83],firmware:[38,62],first:[4,5,6,8,10,11,13,70,82,88],fix:[14,74],fixtur:25,flag:[2,5,11,14,15,31,56,59],flush:10,fmt:74,folder:8,foll:11,follow:[1,2,4,5,7,8,9,10,11,12,13,15,16,18,19,20,23,25,31,70,71,74,80,86,89],foo:[6,11,17,18,20,29,31,33,39,42,48,50,56,63,66,86],foobar:[35,58],foober:[31,50],fooconfig:[33,56],footprint:77,forc:[8,11,44,69],forcesystemexit:7,form:[0,7,11,13,25,77],format:[0,5,8,10,11],former:8,forum:77,forward:[5,8,11],found:[2,7,13,15,16,18,20,25,31,50,89],four:[4,71,83],fqdn:[7,9,10,11,13,23,25,29,31,38,48,50,62,71,86],frag:83,framework:[25,84],fred:11,free:25,freeform:[32,54],frequenc:[7,13],fri:[41,65],from:[0,2,4,5,7,8,10,11,12,13,15,16,17,18,19,20,23,24,25,31,41,44,50,58,65,69,70,71,74,79,80,83,84,85,86,87,88],fsa:5,fulfil:[20,25],full:[4,10,11,13],fulli:[1
0,13,25],fullnam:[44,69],fullscreen:15,fun:[17,18,20,86],further:[2,4,5,11,25,82],futur:[8,13,82],gain:86,gatewai:[11,38,62],gateway:11,gather:[24,25,71,88],gbp:[11,31,50,88],gcc:10,gener:[0,1,8,10],genisoimag:10,geo2:5,geo:[0,3],geo_no_cache_found:13,geoblock:[13,50],geoenabl:[29,48],geograph:[19,83,87],geographi:[11,83],geoip2:[10,13],geoip:10,geolimit:[0,11],geolimitcountri:[31,50],geolimitredirecturl:[31,50],geolit:10,geolite2:10,geolitec:8,geoloc:[5,8,10,11,13,29,48,50,71,72],geolocation6:[8,29,48],geoprovid:[31,50],get:[0,1,2,5,7,8,10,11,13,15,16,17,18,19,20,25,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,60,61,62,63,64,65,66,68,69,74,75],gettext:10,gid:[44,69],gigabit:[31,38,62],git:[11,23,25,71,74],github:[15,16,25,75,77],give:11,given:[2,7,11,13,18,25,29,44,48,69,83,86],global:[2,8,11,15,31,41,50,65,83],globalmaxmbp:[31,50],globalmaxtp:[31,50],gmt:[2,11,17,18,25,86],goal:19,goe:[4,11,13,31,50],golang:88,good:[11,25,75,77],g
oogl:77,goos:[10,25],gopath:[15,74],got:[2,11],gototarget1:6,govern:83,grafana:[11,15,74,88],grafana_url:15,grafanahost:15,grant:[16,25],graph:0,graphic:11,greater:[13,16,74],green:15,grei:11,group:[0,4],grow:13,grunt:70,guarante:8,h710p:[38,62],hack:[7,11,29,48],had:17,hand:11,handl:[5,11,13,31,50,83],handshak:[11,13],happen:13,hard:[8,11],hardcod:25,harden:84,hardwar:[8,11,13,25],hardwareinfo:[38,62],hash:[4,11,13,29,31,38,41,44,45,46,47,48,50,51,62,65,69,71,79,86],hashid:[29,48],hasnegativecachingcustom:[31,50],hasoriginaclwhitelist:[31,50],hasorigindynamicremap:[31,50],hassignedurl:[31,50],hat:[8,11,17,18],have:[2,4,8,10,11,13,15,16,17,18,20,25,56,71,74,75,83,86,87,89],hdr_rewrit:4,hdr_rw_:11,hds:11,head:11,header:[0,2,7,8],header_regexp:11,header_rewrit:11,headerrewriteedg:[31,50],headerrewritemid:[31,50],headerrewriteredirectrout:[31,50],health:[0,7,8],healthi:11,healthparam:[7,29,48],heart:11,heath:7,help:[5,11,15,25,74],helper:25,here:[3,8,11,14,15,16,25,31,41,44,50,65,69,77
,89],hierarchi:86,high:[8,15,25,29,34,48,57],higher:[4,8,10,15,79],highest:[8,10],hint:11,hire:10,histor:7,histori:[11,24,29,48],hit:[8,10,11,17,25,31,50,83,86],hls:11,hmac_md5:11,hmac_sha1:11,home:[15,25],homebrew:25,honor:[13,17,71],hook:25,hop:[77,86],horizont:[13,86],host:[7,10,11,13,14,15,16,17,18,20,25,31,38,39,50,62,63,71,86],host_nam:[11,25,38,62],host_regexp:[11,31,50],hostnam:[7,9,10,11,13,16,18,23,25,26,29,31,32,38,48,50,54,62,79,86,88],hostname:11,hot:[10,14,83],hou:87,hour:[11,13,44,69],hover:11,how:0,howev:[9,11,13,84],html:[5,10,17,18,20,42,66,70,86],http11protocol:71,http:[0,2,4,5,6,7,8,9,10,11,12],http_live:11,http_live_natl:4,http_live_natnl:11,http_no_cache:11,httpbypassfqdn:[31,50],httpd:10,httponly:[2,25],https:0,httpsport:[38,62],human:[10,11,38,62],hundr:[8,19,87],hwinfo:26,hypertext:20,hypnotoad:10,icon:11,idcopyfrom:58,ide:[23,71],idea:75,identifi:[8,11,17,25,27,28,29,30,32,38,45,47,48,49,54,62],ignor:[11,13,31,50],ignore:11,illustr:20,ilo:[9,11,25,42,66],il
o_ip_address:[25,42,66],ilo_ping:[42,66],iloipaddress:[9,38,62],iloipgatewai:[38,62],iloipnetmask:[38,62],ilopassword:[38,62],ilousernam:[38,62],imag:[2,4,11,25,41,65,77,86],image:25,img:[2,44,69],immedi:11,impact:[11,83],imper:13,implement:[11,26,80,82],improv:11,inaccess:[8,11,44,69],inact:[31,50],inc:[38,62],incept:13,inceptiond:[29,48],includ:[5,7,8,11,18,23,25,31,40,50,64,70,71,82,83,85,86],includepostalcod:5,incom:13,incorpor:[10,25],independ:83,index:[10,11,16,56,59],indic:[5,11,17,20,25,38,62],individu:[11,13,15,83],inf:71,influenc:[11,13,17,83,88],influx:15,influxdata:15,influxdb:[0,11],influxdb_tool:[15,74],influxpassword:15,influxurl:15,influxus:15,info:[10,11,14,25,31],info_url:[42,66],inform:[1,8,10,11,13,15,16,18,23,24,25,29,31,41,48,50,65,71,72,75,83,84,86,87,89],informat:[11,15,89],infourl:[8,31,41,50,65],infuxdb:15,init:[10,13,16,71],initi:[10,11,14,25,44,69,75],initial:50,initialdispers:[31,50],inlin:[11,12],input:[11,25,86],insecur:25,insert:[18,20,86],insight:[70
,83,85],inspection:13,instal:[0,7,8,9,10,11,12,13,14,15,16,23,25,41,65,70,71,74,75,86],install:0,installat:[0,8],instanc:[7,8,10,11,23,25,31,38,41,50,62,65,70,71,74,83,86],instance_nam:[8,41,65],instead:13,instruct:[8,10,15,16,31,50],intact:25,inted:11,integ:[47,56,59,62],integr:[15,25,71,80,81],integrat:[25,38,62,71],intel:[38,62],intend:[5,11],intent:11,inter:5,interact:[14,84],interest:[13,18],interf:86,interfac:[8,11,14,25,38,62,71,83,84],interfacemtu:[38,62],interfacenam:[29,38,48,62],intermedi:13,intern:[6,11,13,16,40,64,77,80,82],internal:25,internet:[13,18,19,80,86],interv:[5,7,11,13,15,25,29,48,83,84,88],intervent:11,introduc:81,introduct:22,invalid:[0,8],invok:11,involv:[3,13],ip6:[29,48],ip6_address:25,ip6address:[9,38,62],ip6gatewai:[38,62],ip_address:[25,42,66],ip_allow:[8,11],ipaddr:11,ipaddress:[9,38,62,72],ipaddrr:11,ipgatewai:[38,62],ipnetmask:[38,62],ipv4:[2,5,8,9,11,13,18,20,25,31,38,50,53,62,71,72,75],ipv6:[2,8,9,11,13,25,31,38,50,53,62,71,72,75],ipv6addr:11,ipv6
gatewai:11,ipv6routingen:[31,50],ipwhitelist:5,isact:[42,66],iso8601:[46,51],iso:[0,8,10],isolinux:8,isp:11,issu:[11,71,75,83,86],item:[8,13,24,31],iter:25,itself:[13,22,25],ivh:[10,15],jan:86,jane:[34,57],jar:[7,71],java:[13,16,22],javascript:[25,70,74],jdk:[16,23,71],jeff:8,jenkin:13,jetti:[23,71],jmx:71,job:[11,44,69],joe:15,jpg:[44,69],jre_home:7,json:[2,5,6,7,8,10,11,12,13,14,16,25,26,30,31,32,33,34,37,39,41,42,44,46,49,50,51,53,54,55,57,61,63,65,66,69,70,71,74],junit:[23,71],just:[10,11,24,31,50],jvd:[8,25],kabletown:[1,2,6,7,10,11,13,14,15,16,18],kabletown_cdn:[7,10],kbaletown:[30,49],kbp:[31,51,88],keep:[2,8,11,14,25,59,86],kei:[0,1,10],kepler:[23,71],kept:[7,13,25],keyfil:16,keypair:[29,48],keystor:[11,13,89],keysus:16,keyword:[8,44,69],kick:83,kickstart:0,kickstart_create_network_lin:11,kickstart_drive_config:11,kind:[11,13],kl0tevax:7,know:[11,86],knowledg:13,known:[10,11,83],ks_script:11,ksk:[1,11,13,29,48],kskexpirationdai:[29,48],l4s:5,l9v:5,l9w:5,label:[13,29,31,48],l
acp:11,lai:13,laika:25,land:11,larg:[8,13,19,83,86],larger:[79,86],last:[7,11,13,17,18,25,27,28,32,33,35,38,40,45,47,54,56,58,62,64],last_upd:[28,33,56],lastupdat:[25,27,28,29,30,31,32,34,35,36,38,40,43,44,45,47,48,49,50,52,54,57,58,60,62,64,68,69],lat:11,latch:11,latenc:[13,18,83],later:[5,10,11,15,25,83],latest:[5,8,16],latitud:[11,13,28,29,31,47,48,50],latter:8,launch:11,lax:[41,65,87],layer:[11,31,50,79,86],ldap:10,ldns:[18,20,86],learn:18,least:[1,10,11,75],leav:[10,11,15],left:[8,10,11,25],length:[2,10,13,17,18,20,25,86],lenienc:7,less:[11,15,31,50,74,83,86,88],letter:[10,11],level:[1,2,9,11,13,25,29,30,31,34,36,38,42,44,45,47,48,49,50,52,56,57,58,59,60,62,66,69,83,86],lib:[9,10,25],libcurl:10,libgomp:10,libidn:10,libpcap:10,librari:10,libtool:10,license:77,life:8,lifecycl:[38,62],lifetim:8,light:[25,38,62],lighten:[8,41,65],like:[8,11,13,14,15,17,25,79,84,86],limit:[8,11,31,47,50,86],line:[10,11,15,16,25,31,50],linear:11,link:[10,11,74,88],lint:74,linux:[8,11,23,25,70,71,74],
list:[2,4,5,8,9,11,18,24,25,29,31,40,42,44,48,50,53,64,66,69,71,72,86],list_bucket:16,list_kei:16,listen:[11,16,25,38,62,71],live4:5,live51:5,live5:5,live5_low_bitr:5,live:[5,11,13,20,25,29,44,48,53,69],load:[8,10,11,13,16,25,41,42,65,66,83,86],load_schema:25,loadavg:[8,29,48],loadbalanc:11,loader:10,local0:9,local:[8,9,10,11,13,18,20,23,25,27,28,29,30,32,45,47,48,49,54,70,71,79,80,81,83],localhost:[2,9,10,15,23,25,70,71],localus:[44,69],locat:[0,4,5,7],location1:[34,57],log4j:[11,13],log4perl:10,log:[0,2,5,6],log_level:[9,14],logic:[5,8,87],login:[2,6,7,10,11,15,16,25,44,69],logo:[8,41,65],logourl:[8,41,65],logout:[11,44,69],logsenabl:[31,50],longdesc1:[31,50],longdesc2:[31,50],longdesc:[31,50],longer:[8,11,20,44,69,71],longest:8,longitud:[11,13,28,29,31,47,48,50],look:[16,18,20,25,86],lookup:[9,11,13,31,50],loop:5,lot:[11,75],low:13,low_bitr:5,lower:[4,8,86],lowest:86,ltd:10,m3u8:[5,13],machin:[10,71],macos:[23,25,70,71,74],made:[2,4,11,13,14,15,25,30,44,49,69],mai:[1,4,9,10,11,13
,14,25,44,69,71,82,83],main:[11,18,23,25,38,62,71],mainten:[11,31,50],maintenanceperc:[29,31,48,50],major:[14,19,80],make:[4,5,7,8,11,13,15,19,25,29,31,44,50,69,71,74,75,80,83,86,87],manag:[0,1,6],mangement:25,mani:[8,10,11,13,19,25,44,69,80,83,84,86],m
<TRUNCATED>
[50/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v11/deliveryservice.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v11/deliveryservice.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v11/deliveryservice.txt
index b673a00..73d8ffd 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v11/deliveryservice.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v11/deliveryservice.txt
@@ -25,7 +25,7 @@ Delivery Service
/api/1.1/deliveryservices
+++++++++++++++++++++++++
-**GET /api/1.1/deliveryservices.json**
+**GET /api/1.1/deliveryservices**
Retrieves all delivery services. See also `Using Traffic Ops - Delivery Service <http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
@@ -35,172 +35,224 @@ Delivery Service
**Response Properties**
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description | |
- +==========================+========+======================================================================================================================================+=====================================================================================================+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``active`` | bool | true if active, false if inactive. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE | |
- | | | - 1: serve with https:// at EDGE | |
- | | | - 2: serve with both http:// and https:// at EDGE | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | string | - 0: None - no limitations | |
- | | | - 1: Only route on CZF file hit | |
- | | | - 2: Only route on CZF hit or when from USA | |
- | | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents | |
- | | | routing to the content by Traffic Router. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the | |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded | |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for | |
- | | | HTTP deliveryservices | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``headerRewrite`` | string | The EDGE header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``id`` | string | The deliveryservice id (database row number). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field 1. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 2. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``matchList`` | array | Array of matchList hashes. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all | |
- | | | available). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | string | | Is the Multi Site Origin feature enabled for this delivery service. See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the | |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. | |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. | |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. | |
- | | | - true: token based auth is enabled for this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: | |
- | | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) | |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. | |
- | | | - 2 Use the cache_range_requests plugin. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | string | Entry points into the CDN for this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
- },
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
{ .. },
{ .. }
- ],
+ ]
}
-
|
-**GET /api/1.1/deliveryservices/:id.json**
+
+**GET /api/1.1/deliveryservices/:id**
Retrieves a specific delivery service. See also `Using Traffic Ops - Delivery Service <http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
@@ -213,20 +265,20 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+========+======================================================================================================================================+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``active`` | bool | true if active, false if inactive. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -239,6 +291,10 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimit`` | string | - 0: None - no limitations |
| | | - 1: Only route on CZF file hit |
| | | - 2: Only route on CZF hit or when from USA |
@@ -246,6 +302,10 @@ Delivery Service
| | | Note that this does not prevent access to content or makes content secure; it just prevents |
| | | routing to the content by Traffic Router. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
| | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -253,8 +313,6 @@ Delivery Service
| | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
| | | HTTP deliveryservices |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``headerRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -262,8 +320,14 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc`` | string | Description field 1. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc1`` | string | Description field 2. |
@@ -281,96 +345,138 @@ Delivery Service
| ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
| | | available). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
| | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
| | | - 2: drop query string at edge, and do not use it in the cache-key. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``remapText`` | string | Additional raw remap line text. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
| | | - true: token based auth is enabled for this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | string | Entry points in to the CDN for this deliveryservice. |
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
-
{
"response": [
{
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
}
- ],
+ ]
}
|
+
.. _to-api-v11-ds-health:
Health
[23/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt b/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt
index 01987eb..61d6c0b 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt
@@ -24,7 +24,7 @@ Physical Location
/api/1.1/phys_locations
+++++++++++++++++++++++
-**GET /api/1.1/phys_locations.json**
+**GET /api/1.1/phys_locations**
Authentication Required: Yes
@@ -35,30 +35,34 @@ Physical Location
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``region`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``poc`` | string | |
+ |``address`` | string | |
+----------------------+--------+------------------------------------------------+
- |``name`` | string | |
+ |``city`` | string | |
+----------------------+--------+------------------------------------------------+
|``comments`` | string | |
+----------------------+--------+------------------------------------------------+
- |``phone`` | string | |
+ |``email`` | string | |
+----------------------+--------+------------------------------------------------+
- |``state`` | string | |
+ |``id`` | string | |
+----------------------+--------+------------------------------------------------+
- |``email`` | string | |
+ |``lastUpdated`` | string | |
+----------------------+--------+------------------------------------------------+
- |``city`` | string | |
+ |``name`` | string | |
+----------------------+--------+------------------------------------------------+
- |``zip`` | string | |
+ |``phone`` | string | |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
+ |``poc`` | string | |
+----------------------+--------+------------------------------------------------+
- |``address`` | string | |
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+----------------------+--------+------------------------------------------------+
|``shortName`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
@@ -66,7 +70,9 @@ Physical Location
"response": [
{
"region": "Mile High",
+ "region": "4",
"poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
"name": "Albuquerque",
"comments": "Albuquerque",
"phone": "(123) 555-1111",
@@ -79,20 +85,22 @@ Physical Location
"shortName": "Albuquerque"
},
{
- "region": "Chicago",
- "poc": "John Doe",
- "name": "Chicago",
- "comments": "",
- "phone": "(321) 555-1111",
- "state": "IL",
- "email": "john.doe@email.com",
- "city": "Chicago",
- "zip": "60636",
- "id": "3",
- "address": "123 East 4th Street",
- "shortName": "chicago"
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
}
- ],
+ ]
}
|
@@ -121,7 +129,322 @@ Physical Location
{
"name": "Ashburn"
}
- ],
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/phys_locations/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Physical location ID. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
}
+|
+
+**PUT /api/1.1/phys_locations/:id**
+ Update a physical location
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Physical location id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+================================================+
+ | ``address`` | yes | Physical location address. |
+ +-------------------+----------+------------------------------------------------+
+ | ``city`` | yes | Physical location city. |
+ +-------------------+----------+------------------------------------------------+
+ | ``comments`` | no | Physical location comments. |
+ +-------------------+----------+------------------------------------------------+
+ | ``email`` | no | Physical location email. |
+ +-------------------+----------+------------------------------------------------+
+ | ``name`` | yes | Physical location name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``phone`` | no | Physical location phone. |
+ +-------------------+----------+------------------------------------------------+
+ | ``poc`` | no | Physical location point of contact. |
+ +-------------------+----------+------------------------------------------------+
+ | ``regionId`` | no | Physical location region ID. |
+ +-------------------+----------+------------------------------------------------+
+ | ``shortName`` | yes | Physical location short name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``state`` | yes | Physical location state. |
+ +-------------------+----------+------------------------------------------------+
+ | ``zip`` | yes | Physical location zip. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "regionId": "1",
+ "poc": "Jane Doesssss",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "address": "123 East 9rd St",
+ "shortName": "Albuquerque"
+ }
+
+|
+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Physical location update was successful."
+ }
+ ],
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.1/regions/:region_name/phys_locations**
+ Create physical location.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ region_name: the name of the region to create physical location into.
+
+ **Request Route Parameters**
+
+ +-----------------+----------+-----------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================+
+ | ``region_name`` | yes | The name of the physical location |
+ +-----------------+----------+-----------------------------------+
+
+ **Request Properties**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | yes | The name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``shortName`` | yes | The short name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``address`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``city`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``state`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``zip`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``phone`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``poc`` | no | Point of contact |
+ +-----------------+----------+---------------------------------------------------+
+ | ``email`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``comments`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name" : "my physical location1",
+ "shortName" : "myphylocation1",
+ "address" : "",
+ "city" : "Shanghai",
+ "state": "SH",
+ "zip": "200000",
+ "comments": "this is physical location1"
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------+--------+---------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+===================================================+
+ | ``id`` | string | The id of the physical location created. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``name`` | string | The name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``shortName`` | string | The short name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionName`` | string | The region name the physical location belongs to. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionId`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``address`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``city`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``state`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``zip`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``phone`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``poc`` | string | Point of contact |
+ +-----------------+--------+---------------------------------------------------+
+ | ``email`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``comments`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'shortName': 'myphylocati',
+ 'regionName': 'myregion1',
+ 'name': 'my physical location1',
+ 'poc': '',
+ 'phone': '',
+ 'comments': 'this is physical location1',
+ 'state': 'SH',
+ 'email': '',
+ 'zip': '20000',
+ 'region_id': '20',
+ 'city': 'Shanghai',
+ 'address': '',
+ 'id': '200'
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt b/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt
index 83d54f2..97075d8 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt
@@ -24,7 +24,7 @@ Profiles
/api/1.1/profiles
+++++++++++++++++
-**GET /api/1.1/profiles.json**
+**GET /api/1.1/profiles**
Authentication Required: Yes
@@ -59,7 +59,7 @@ Profiles
|
-**GET /api/1.1/profiles/trimmed.json**
+**GET /api/1.1/profiles/trimmed**
Authentication Required: Yes
@@ -84,3 +84,47 @@ Profiles
}
|
+
+**GET /api/1.1/profiles/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+------------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+============+================================================+
+ | ``id`` | yes | The ID of the profile. |
+ +-----------------+------------+------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/region.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/region.txt b/docs/latest/_sources/development/traffic_ops_api/v11/region.txt
index f7d993d..7eda251 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/region.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/region.txt
@@ -24,7 +24,7 @@ Regions
/api/1.1/regions
++++++++++++++++
-**GET /api/1.1/regions.json**
+**GET /api/1.1/regions**
Authentication Required: Yes
@@ -35,9 +35,13 @@ Regions
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``name`` | string | |
+ |``id`` | string | Region ID. |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+----------------------+--------+------------------------------------------------+
**Response Example** ::
@@ -45,13 +49,188 @@ Regions
{
"response": [
{
+ "id": "6",
"name": "Atlanta",
- "id": "6"
+ "division": "2",
+ "divisionName": "West"
+ },
+ {
+ "id": "7",
+ "name": "Denver",
+ "division": "2",
+ "divisionName": "West"
},
+ ]
+ }
+
+
+**GET /api/1.1/regions/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Region id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
{
- "name": "Beltway",
- "id": "1"
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
}
- ],
+ ]
+ }
+
+
+**PUT /api/1.1/regions/:id**
+ Update a region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Region id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +================+==========+==========================+
+ | ``name`` | yes | The name of the region |
+ +----------------+----------+--------------------------+
+ | ``division`` | yes | The division Id |
+ +----------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ "division": "4"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``division`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Region update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "myregion1",
+ "division": "4",
+ "divisionName": "mydivision1"
+ }
+ }
+|
+
+**POST /api/1.1/divisions/:division_name/regions**
+ Create Region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ division_name - The name of division to create new region into.
+
+ ** Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +===================+==========+================================================+
+ | ``division_name`` | yes | The name of division will create new region in |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+==========================================+
+ | ``name`` | yes | The name of the region |
+ +-------------------+----------+------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+===========================================+
+ | ``name`` | string | name of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``id`` | string | id of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionName`` | string | the division name the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionId`` | string | the id of division the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'divisionName': 'mydivision1',
+ 'divsionId': '4',
+ 'name': 'myregion1',
+ 'id': '19'
+ }
}
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/server.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/server.txt b/docs/latest/_sources/development/traffic_ops_api/v11/server.txt
index 9c437b8..61184f9 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/server.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/server.txt
@@ -24,7 +24,7 @@ Server
/api/1.1/servers
++++++++++++++++
-**GET /api/1.1/servers.json**
+**GET /api/1.1/servers**
Retrieves properties of CDN servers.
@@ -34,10 +34,170 @@ Server
**Request Query Parameters**
+ +--------------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +====================+==========+=============================================+
+ | ``dsId`` | no | Used to filter servers by delivery service. |
+ +--------------------+----------+---------------------------------------------+
+ | ``status`` | no | Used to filter servers by status. |
+ +--------------------+----------+---------------------------------------------+
+ | ``type`` | no | Used to filter servers by type. |
+ +--------------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/servers/:id**
+
+ Retrieves properties of a CDN server by server ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+-----------+----------+---------------------------------------------+
| Name | Required | Description |
+===========+==========+=============================================+
- | ``dsId`` | no | Used to filter servers by delivery service. |
+ | ``id`` | yes | Server id. |
+-----------+----------+---------------------------------------------+
**Response Properties**
@@ -47,10 +207,20 @@ Server
+====================+========+============================================================================================================+
| ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``domainName`` | string | The domain name part of the FQDN of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``hostName`` | string | The host name part of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``id`` | string | The server id (database row number). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
@@ -85,10 +255,18 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``rack`` | string | A string indicating rack location. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``routerHostName`` | string | The human readable name of the router. |
@@ -97,15 +275,15 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppId`` | string | Deprecated. |
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppPasswd`` | string | Deprecated. |
+ | ``updPending`` | bool | |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -114,7 +292,11 @@ Server
"response": [
{
"cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
"domainName": "chi.kabletown.net",
+ "guid": null,
"hostName": "atsec-chi-00",
"id": "19",
"iloIpAddress": "172.16.2.6",
@@ -133,27 +315,30 @@ Server
"mgmtIpAddress": "",
"mgmtIpGateway": "",
"mgmtIpNetmask": "",
+ "offlineReason": "N/A",
"physLocation": "plocation-chi-1",
+ "physLocationId": "9",
"profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
"rack": "RR 119.02",
"routerHostName": "rtr-chi.kabletown.net",
"routerPortName": "2",
"status": "ONLINE",
+ "statusId": "6",
"tcpPort": "80",
"httpsPort": "443",
"type": "EDGE",
- "xmppId": "atsec-chi-00-dummyxmpp",
- "xmppPasswd": "**********"
- },
- {
- ... more server data
+ "typeId": "3",
+ "updPending": false
}
]
}
|
-**GET /api/1.1/servers/summary.json**
+
+**GET /api/1.1/servers/summary**
Retrieves a count of CDN servers by type.
@@ -199,7 +384,7 @@ Server
|
-**GET /api/1.1/servers/hostname/:name/details.json**
+**GET /api/1.1/servers/hostname/:name/details**
Retrieves the details of a server.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/status.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/status.txt b/docs/latest/_sources/development/traffic_ops_api/v11/status.txt
index 0f2b7e0..853f276 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/status.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/status.txt
@@ -24,9 +24,9 @@ Status
/api/1.1/statuses
+++++++++++++++++
-**GET /api/1.1/statuses.json**
+**GET /api/1.1/statuses**
- Retrieves a list of the server status codes available. May be useful when the status is retrieved from other APIs as a number and not a string.
+ Retrieves a list of the server status codes available.
Authentication Required: Yes
@@ -37,49 +37,92 @@ Status
+-----------------+--------+--------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=================+========+================================================================================+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+-----------------+--------+--------------------------------------------------------------------------------+
| ``name`` | string | The string equivalent of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
- | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
- +-----------------+--------+--------------------------------------------------------------------------------+
| ``description`` | string | A short description of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"id": "4",
"name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"lastUpdated": "2013-02-13 16:34:29"
},
{
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "CCR_IGNORE",
"id": "5",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"
+ "name": "CCR_IGNORE",
+ "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
"id": "1",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "OFFLINE"
+ "name": "OFFLINE",
+ "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "2",
+ "name": "ONLINE",
"description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "ONLINE"
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "3",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
"name": "REPORTED",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
+
+**GET /api/1.1/statuses/:id**
+
+ Retrieves a server status by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Status id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"lastUpdated": "2013-02-13 16:34:29"
}
- ],
+ ]
}
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/type.txt b/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
index c2d52d6..2430b97 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
@@ -24,46 +24,54 @@ Types
/api/1.1/types
++++++++++++++
-**GET /api/1.1/types.json**
+**GET /api/1.1/types**
Authentication Required: Yes
Role(s) Required: None
+ **Request Query Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``useInTable`` | no | Filter types by the table in which they apply |
+ +----------------+----------+----------------------------------------------------+
+
**Response Properties**
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
+ |``id`` | string | |
+----------------------+--------+------------------------------------------------+
|``name`` | string | |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
|``description`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "lastUpdated": "2013-10-23 15:28:31",
- "useInTable": "staticdnsentry",
- "name": "AAAA_RECORD",
"id": "22",
- "description": "Static DNS AAAA entry"
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
}
- ],
+ ]
}
|
-**GET /api/1.1/types/trimmed.json**
+**GET /api/1.1/types/trimmed**
Authentication Required: Yes
@@ -96,3 +104,49 @@ Types
],
}
+**GET /api/1.1/types/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``id`` | yes | Type ID. |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/user.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/user.txt b/docs/latest/_sources/development/traffic_ops_api/v11/user.txt
index 2339d10..5b06ccc 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/user.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/user.txt
@@ -24,7 +24,7 @@ Users
/api/1.1/users
++++++++++++++
-**GET /api/1.1/users.json**
+**GET /api/1.1/users**
Retrieves all users.
@@ -37,70 +37,177 @@ Users
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``email`` | string | |
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+----------------------+--------+------------------------------------------------+
|``city`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
|``id`` | hash | |
+----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
|``phoneNumber`` | string | |
+----------------------+--------+------------------------------------------------+
- |``company`` | string | |
+ |``postalCode`` | string | |
+----------------------+--------+------------------------------------------------+
- |``country`` | string | |
+ |``publicSshKey`` | string | |
+----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
+ |``registrationSent`` | string | |
+----------------------+--------+------------------------------------------------+
- |``localUser`` | string | |
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+----------------------+--------+------------------------------------------------+
|``uid`` | string | |
+----------------------+--------+------------------------------------------------+
|``username`` | string | |
+----------------------+--------+------------------------------------------------+
- |``rolename`` | string | |
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/users/:id**
+
+ Retrieves user by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | User id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+----------------------+--------+------------------------------------------------+
- |``newUser`` | string | |
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+----------------------+--------+------------------------------------------------+
|``addressLine2`` | string | |
+----------------------+--------+------------------------------------------------+
- |``role`` | string | |
+ |``city`` | string | |
+----------------------+--------+------------------------------------------------+
- |``addressLine1`` | string | |
+ |``company`` | string | |
+----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+----------------------+--------+------------------------------------------------+
|``gid`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
-
- [
- {
- "email": "email@email.com",
- "city": "",
- "id": "54",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "Bob Simpson",
- "localUser": false,
- "uid": "0",
- "stateOrProvince": "",
- "username": "bsimpson",
- "rolename": "portal",
- "newUser": true,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "postalCode": "",
- "gid": "0"
- }
- ]
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ }
+ ]
+ }
|
-**GET /api/1.1/user/current.json**
+
+**GET /api/1.1/user/current**
Retrieves the profile for the authenticated user.
[35/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/cache_stats.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/cache_stats.html b/docs/1.7.0/development/traffic_ops_api/v12/cache_stats.html
index 0a555a1..8803956 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/cache_stats.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/cache_stats.html
@@ -304,49 +304,49 @@
</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">"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>
+<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">"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">29</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"bandwidth"</span><span class="p">,</span>
- <span class="s">"tags"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"cdn"</span><span class="p">:</span> <span class="s">"over-the-top"</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">29</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bandwidth"</span><span class="p">,</span>
+ <span class="s2">"tags"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"over-the-top"</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-10T22:40:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-10T22:40:00Z"</span><span class="p">,</span>
<span class="mi">229340299720</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-10T22:41:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-10T22:41:00Z"</span><span class="p">,</span>
<span class="mf">224309221713.334</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-10T22:42:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-10T22:42:00Z"</span><span class="p">,</span>
<span class="mf">229551834168.334</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-10T22:43:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-10T22:43:00Z"</span><span class="p">,</span>
<span class="mf">225179658876.667</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s">"2015-08-10T22:44:00Z"</span><span class="p">,</span>
+ <span class="s2">"2015-08-10T22:44:00Z"</span><span class="p">,</span>
<span class="mi">230443968275</span>
<span class="p">]</span>
<span class="p">]</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">970410.295</span><span class="p">,</span>
- <span class="s">"count"</span><span class="p">:</span> <span class="mi">1376041798</span><span class="p">,</span>
- <span class="s">"fifthPercentile"</span><span class="p">:</span> <span class="mf">202.03</span><span class="p">,</span>
- <span class="s">"max"</span><span class="p">:</span> <span class="mf">3875441.02</span><span class="p">,</span>
- <span class="s">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">2957940.93</span><span class="p">,</span>
- <span class="s">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">2366728.63</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">970410.295</span><span class="p">,</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1376041798</span><span class="p">,</span>
+ <span class="s2">"fifthPercentile"</span><span class="p">:</span> <span class="mf">202.03</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">3875441.02</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">2957940.93</span><span class="p">,</span>
+ <span class="s2">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">2366728.63</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/1.7.0/development/traffic_ops_api/v12/cachegroup.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/cachegroup.html b/docs/1.7.0/development/traffic_ops_api/v12/cachegroup.html
index 53c4c40..26802f7 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/cachegroup.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/cachegroup.html
@@ -190,16 +190,16 @@
<span id="to-api-v12-cachegroup"></span><h1>Cache Group<a class="headerlink" href="#cache-group" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-cachegroups">
<span id="to-api-v12-cachegroups-route"></span><h2>/api/1.2/cachegroups<a class="headerlink" href="#api-1-2-cachegroups" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cachegroups.json</strong></p>
+<p><strong>GET /api/1.1/cachegroups</strong></p>
<blockquote>
<div><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="23%" />
-<col width="8%" />
-<col width="70%" />
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -208,70 +208,86 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>Longitude for the Cache Group</td>
+<td>Local unique identifier for the Cache Group</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
-<td>Identifier that refers to the ‘id’ field of different Cache Group entry.</td>
+<td>The Time / Date this entry was last updated</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
<td>string</td>
-<td>The Time / Date this entry was last updated</td>
+<td>Latitude for the Cache Group</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
<td>string</td>
-<td>The type name of Cache Group entry</td>
+<td>Longitude for the Cache Group</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The name of the Cache Group entry</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
<td>string</td>
-<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+<td>Parent cachegroup ID.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td>
<td>string</td>
-<td>Latitude for the Cache Group</td>
+<td>Parent cachegroup name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
<td>string</td>
-<td>Local unique identifier for the Cache Group</td>
+<td>Secondary parent cachegroup ID.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>Abbreviation of the Cache Group Name</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</td>
+</tr>
</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">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:32:03"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dccmc"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago-1"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -281,10 +297,10 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cachegroups/trimmed.json</strong></p>
+<p><strong>GET /api/1.2/cachegroups/trimmed</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
-<p>Role(s) Required Required: None</p>
+<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -306,23 +322,116 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "name": "dc-chicago"
- },
- {
- "name": "dc-cmc"
- }
- ],
-}
+<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">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</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/cachegroup/:parameter_id/parameter.json</strong></p>
+<p><strong>GET /api/1.2/cachegroups/:id</strong></p>
+<blockquote>
+<div><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="30%" />
+<col width="7%" />
+<col width="63%" />
+</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>Local unique identifier for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
+<td>string</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
+<td>string</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
+<td>string</td>
+<td>Parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td>
+<td>string</td>
+<td>Parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</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">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</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/cachegroup/:parameter_id/parameter</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -375,16 +484,16 @@
</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">"cachegroups"</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="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -395,7 +504,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cachegroupparameters.json</strong></p>
+<p><strong>GET /api/1.2/cachegroupparameters</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -432,23 +541,23 @@
</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">"cachegroupParameters"</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="s2">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"380"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"380"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -459,7 +568,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cachegroups/:parameter_id/parameter/available.json</strong></p>
+<p><strong>GET /api/1.2/cachegroups/:parameter_id/parameter/available</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -508,15 +617,15 @@
</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">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -576,13 +685,13 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"cache_group_edge"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"cg_edge"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
- <span class="s">"parentCachegroup"</span><span class="p">:</span> <span class="s">"cache_group_mid"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"EDGE_LOC"</span>
+<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">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"cg_edge"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s2">"parentCachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_mid"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"EDGE_LOC"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -659,25 +768,25 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Cachegroup successfully created: cache_group_edge"</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">"Cachegroup successfully created: cache_group_edge"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">'longitude'</span> <span class="p">:</span> <span class="s">'45'</span><span class="p">,</span>
- <span class="s">'lastUpdated'</span> <span class="p">:</span> <span class="s">'2016-01-25 13:55:30'</span><span class="p">,</span>
- <span class="s">'shortName'</span> <span class="p">:</span> <span class="s">'cg_edge'</span><span class="p">,</span>
- <span class="s">'name'</span> <span class="p">:</span> <span class="s">'cache_group_edge'</span><span class="p">,</span>
- <span class="s">'parentCachegroup'</span> <span class="p">:</span> <span class="s">'cache_group_mid'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'latitude'</span> <span class="p">:</span> <span class="s">'12'</span><span class="p">,</span>
- <span class="s">'typeName'</span> <span class="p">:</span> <span class="s">'EDGE_LOC'</span><span class="p">,</span>
- <span class="s">'id'</span> <span class="p">:</span> <span class="s">'104'</span><span class="p">,</span>
- <span class="s">'parentCachegroupId'</span> <span class="p">:</span> <span class="s">'103'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'longitude'</span> <span class="p">:</span> <span class="s1">'45'</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s1">'shortName'</span> <span class="p">:</span> <span class="s1">'cg_edge'</span><span class="p">,</span>
+ <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_mid'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'latitude'</span> <span class="p">:</span> <span class="s1">'12'</span><span class="p">,</span>
+ <span class="s1">'typeName'</span> <span class="p">:</span> <span class="s1">'EDGE_LOC'</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'104'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroupId'</span> <span class="p">:</span> <span class="s1">'103'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -756,13 +865,13 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"cache_group_edge"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"cg_edge"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
- <span class="s">"parentCachegroup"</span><span class="p">:</span> <span class="s">"cache_group_mid"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"EDGE_LOC"</span>
+<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">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"cg_edge"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s2">"parentCachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_mid"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"EDGE_LOC"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -839,25 +948,25 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Cachegroup was updated: cache_group_edge"</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">"Cachegroup was updated: cache_group_edge"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">'longitude'</span> <span class="p">:</span> <span class="s">'45'</span><span class="p">,</span>
- <span class="s">'lastUpdated'</span> <span class="p">:</span> <span class="s">'2016-01-25 13:55:30'</span><span class="p">,</span>
- <span class="s">'shortName'</span> <span class="p">:</span> <span class="s">'cg_edge'</span><span class="p">,</span>
- <span class="s">'name'</span> <span class="p">:</span> <span class="s">'cache_group_edge'</span><span class="p">,</span>
- <span class="s">'parentCachegroup'</span> <span class="p">:</span> <span class="s">'cache_group_mid'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'latitude'</span> <span class="p">:</span> <span class="s">'12'</span><span class="p">,</span>
- <span class="s">'typeName'</span> <span class="p">:</span> <span class="s">'EDGE_LOC'</span><span class="p">,</span>
- <span class="s">'id'</span> <span class="p">:</span> <span class="s">'104'</span><span class="p">,</span>
- <span class="s">'parentCachegroupId'</span> <span class="p">:</span> <span class="s">'103'</span><span class="p">,</span>
- <span class="s">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'longitude'</span> <span class="p">:</span> <span class="s1">'45'</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s1">'shortName'</span> <span class="p">:</span> <span class="s1">'cg_edge'</span><span class="p">,</span>
+ <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_mid'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'latitude'</span> <span class="p">:</span> <span class="s1">'12'</span><span class="p">,</span>
+ <span class="s1">'typeName'</span> <span class="p">:</span> <span class="s1">'EDGE_LOC'</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'104'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroupId'</span> <span class="p">:</span> <span class="s1">'103'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -920,11 +1029,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Cachegroup was deleted: cache_group_edge"</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">"Cachegroup was deleted: cache_group_edge"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1020,18 +1129,18 @@
</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">"cachegroupName"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"action"</span><span class="p">:</span> <span class="s">"queue"</span><span class="p">,</span>
- <span class="s">"serverNames"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"atsec-chi-01"</span><span class="p">,</span>
- <span class="s">"atsec-chi-02"</span><span class="p">,</span>
- <span class="s">"atsec-chi-03"</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="s2">"cachegroupName"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"queue"</span><span class="p">,</span>
+ <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-01"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-02"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-03"</span><span class="p">,</span>
<span class="p">],</span>
- <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"93"</span><span class="p">,</span>
- <span class="s">"cdn"</span><span class="p">:</span> <span class="s">"cdn_number_1"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"93"</span><span class="p">,</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1086,8 +1195,8 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1136,20 +1245,20 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": {
- "id": 3,
- "serverNames": [ "atlanta-edge-01", "atlanta-edge-07" ],
- "deliveryServices": [ 234, 235 ]
- }
- "alerts":
- [
- {
- "level": "success",
- "text": "Delivery services successfully assigned to all the servers of cache group 3."
- }
- ],
-}
+<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">"id"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"atlanta-edge-01"</span><span class="p">,</span> <span class="s2">"atlanta-edge-07"</span> <span class="p">],</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</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">"Delivery services successfully assigned to all the servers of cache group 3."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
[25/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/admin/quick_howto/multi_site.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/multi_site.txt b/docs/latest/_sources/admin/quick_howto/multi_site.txt
index 514fd50..0811056 100644
--- a/docs/latest/_sources/admin/quick_howto/multi_site.txt
+++ b/docs/latest/_sources/admin/quick_howto/multi_site.txt
@@ -64,6 +64,10 @@ Configure Multi Site Origin
+------------------+--------------------------------------------------------------------------------------------------------------------+
| Primary/back | Round robin selection does not occur. The first origin server is selected unless it fails. |
| | If the first fails, the second and other following origin servers will be tried by order. |
+| | Order is defined by 2 factors - if the origin server's cachegroup is configured as the |
+| | parent cachegroup for the mid, then this server will be used as the primary. The same rules |
+| | apply for secondary parents, in order. Within the cachegroups, the rank parameter will sort |
+| | order further. If no parents are defined at the mid, then only rank is considered. |
+------------------+--------------------------------------------------------------------------------------------------------------------+
| Strict | MID caches serve requests strictly in turn. For example: origin server 1 serves the first request, |
| round-robin | origin server 2 serves the second request, and so on. |
@@ -72,7 +76,7 @@ Configure Multi Site Origin
| round-robin | |
+------------------+--------------------------------------------------------------------------------------------------------------------+
-7) Optionally, if "Primary/backup" is selected for "Multi Site Origin Algorithm", a new parameter \u201crank\u201d should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of "2" precedes OS with the rank of "5". For any OS, if rank value is not defined in its profile, its rank value will default to \u201c1\u201d.
+7) Optionally, there are two configuration options that can set the order of the origins used if "Primary/backup" is selected for "Multi Site Origin Algorithm". By creating location-based cachegroups and assigning the origin servers accordingly and defining these cachegroups as parents for specific mids, location-based primary/secondary selection can be made. If primary/secondary selection should be the same for all mids, then a new parameter \u201crank\u201d should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of "2" precedes OS with the rank of "5". For any OS, if rank value is not defined in its profile, its rank value will default to \u201c1\u201d. In the event that both location based cachegroups are used alongside rank, sorting will be by cachegroup first and rank second. In this way it is possible to have specific backup servers for use at specific locations.
.. image:: mso-rank.png
:scale: 60%
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/admin/traffic_router.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_router.txt b/docs/latest/_sources/admin/traffic_router.txt
index 774cfe9..8f274a7 100644
--- a/docs/latest/_sources/admin/traffic_router.txt
+++ b/docs/latest/_sources/admin/traffic_router.txt
@@ -17,6 +17,10 @@
*****************************
Traffic Router Administration
*****************************
+.. contents::
+ :depth: 2
+ :backlinks: top
+
Installing Traffic Router
==========================
The following are requirements to ensure an accurate set up:
@@ -387,3 +391,105 @@ The following needs to be completed for Steering to work correctly:
For more information see the `steering how-to guide <quick_howto/steering.html>`_.
+HTTPS for Http Type Delivery Services
+=====================================
+
+Starting with version 1.7 Traffic Router added the ability to allow https traffic between itself and clients on a per http type delivery service basis.
+
+.. Warning::
+ The establishing of an HTTPS connection is much more computationally demanding than an HTTP connection.
+ Since each client will in turn get redirected to ATS, Traffic Router is most always creating a new HTTPS connection for all HTTPS traffic.
+ It is likely to mean that an existing Traffic Router will have some decrease in performance depending on the amount of https traffic you want to support
+ As noted for DNSSEC, you may need to plan to scale Traffic Router vertically and/or horizontally to handle the new load
+
+The summary for setting up https is to:
+
+#. Select one of 'https', 'http and https', or 'http to https' for the delivery service
+#. Generate private keys for the delivery service using a wildcard domain such as ``*.my-delivery-service.my-cdn.example.com``
+#. Obtain and import signed certificate chain
+#. Snapshot CR Config
+
+Clients may make HTTPS requests delivery services only after Traffic Router receives the certificate chain from Traffic Ops and the new CR Config.
+
+Protocol Options
+----------------
+
+*https only*
+ Traffic Router will only redirect (send a 302) to clients communicating with a secure connection, all other clients will receive a 503
+*http and https*
+ Traffic Router will redirect both secure and non-secure clients
+*http to https*
+ Traffic Router will redirect non-secure clients with a 302 and a location that is secure (i.e. starting with 'https' instead of 'http'), secure clients will remain on https
+*http*
+ Any secure client will get an SSL handshake error. Non-secure clients will experience the same behavior as prior to 1.7
+
+Certificate Retrieval
+---------------------
+
+.. Warning::
+ If you have https delivery services in your CDN, Traffic Router will not accept **any** connections until it is able to
+ fetch certificates from Traffic Ops and load them into memory. Traffic Router does not persist certificates to the java keystore or anywhere else.
+
+Traffic Router fetches certificates into memory:
+
+* At startup time
+* When it receives a new CR Config
+* Once an hour from whenever the most recent of the last of the above occurred
+
+.. Note::
+ To adjust the frequency when Traffic Router fetches certificates add the parameter 'certificates.polling.interval' to CR Config and
+ setting it to the desired time in milliseconds.
+
+.. Note::
+ Taking a snapshot of CR Config may be used at times to avoid waiting the entire polling cycle for a new set of certificates.
+
+.. Warning::
+ If a snapshot of CR Config is made that involves a delivery service missing its certificates, Traffic Router will ignore **ALL** changes in that CR-Config
+ until one of the following occurs:
+ * It receives certificates for that delivery service
+ * Another snapshot of CR Config is created and the delivery service without certificates is changed so it's HTTP protocol is set to 'http'
+
+Certificate Chain Ordering
+--------------------------
+
+The ordering of certificates within the certificate bundle matters. It must be:
+
+#. Primary Certificate (e.g. the one created for ``*.my-delivery-service.my-cdn.example.com``)
+#. Intermediate Certificate(s)
+#. Root Certificate from CA (optional)
+
+.. Warning::
+ If something is wrong with the certificate chain (e.g. the order of the certificates is backwards or for the wrong domain) the
+ client will get an SSL handshake. Inspection of /opt/tomcat/logs/catalina.out is likely to yield information to reveal this.
+
+To see the ordering of certificates you may have to manually split up your certificate chain and use openssl on each individual certificate
+
+Suggested Way of Setting up an HTTPS Delivery Service
+-----------------------------------------------------
+
+Do the following in Traffic Ops:
+
+#. Select one of 'https', 'http and https', or 'http to https' for the protocol field of a delivery service and click 'Save'.
+#. Click 'Manage SSL Keys'.
+#. Click 'Generate New Keys'.
+#. Copy the contents of the Certificate Signing Request field and save it locally.
+#. Click 'Load Keys'.
+#. Select 'http' for the protocol field of the delivery service and click 'Save' (to avoid preventing other CR Config updates from being blocked by Traffic Router)
+#. Follow your standard procedure for obtaining your signed certificate chain from a CA.
+#. After receiving your certificate chain import it into Traffic Ops.
+#. Edit the delivery service.
+#. Restore your original choice for the protocol field and click save.
+#. Click 'Manage SSL Keys'.
+#. Click 'Paste Existing Keys'.
+#. Paste the certificate chain into the CRT field.
+#. Click 'Load Keys'.
+#. Take a new snapshot of CR Config.
+
+Once this is done you should be able to test you are getting correctly redirected by Traffic Router using curl commands to https destinations on your delivery service.
+
+A new testing tool was created for load testing traffic router, it allows you to generate requests from your local box to multiple delivery services of a single cdn.
+You can control which cdn, delivery services, how many transactions per delivery service, and how many concurrent requests.
+During the test it will provide feedback about request latency and transactions per second.
+
+While it is running it is suggested that you monitor your Traffic Router nodes for memory and CPU utilization.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/admin/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_stats.txt b/docs/latest/_sources/admin/traffic_stats.txt
index 9231fc7..e8d9e78 100644
--- a/docs/latest/_sources/admin/traffic_stats.txt
+++ b/docs/latest/_sources/admin/traffic_stats.txt
@@ -18,7 +18,7 @@
Traffic Stats Administration
****************************
-Traffic Stats actually consists of three seperate components: Traffic Stats, InfluxDB, and Grafana. See below for information on installing and configuring each component as well as configuring the integration between the three and Traffic Ops.
+Traffic Stats consists of three seperate components: Traffic Stats, InfluxDB, and Grafana. See below for information on installing and configuring each component as well as configuring the integration between the three and Traffic Ops.
Installation
========================
@@ -31,14 +31,14 @@ Installation
**Installing InfluxDB:**
- **As of Traffic Stats 1.4.0, InfluxDb 0.9.6 or higher is required. For InfluxDb versions less than 0.9.6 use Traffic Stats 1.3.0**
+ **As of Traffic Stats 1.8.0, InfluxDb 1.0.0 or higher is required. For InfluxDb versions less than 1.0.0 use Traffic Stats 1.7.x**
- In order to store traffic stats data you will need to install InfluxDB. It is recommended InfluxDB be installed in a 3 server cluster; VMs are acceptable. The documentation for installing InfluxDB can be found on the InfluxDB `website <https://docs.influxdata.com/influxdb/latest/introduction/installation/>`_.
+ In order to store traffic stats data you will need to install `InfluxDB <https://docs.influxdata.com/influxdb/latest/introduction/installation/>`_. While not required, it is recommended to use some sort of high availability option like `Influx enterprise <https://portal.influxdata.com/>`_, `Influxdb Relay <https://github.com/influxdata/influxdb-relay>`_, or another `high availability option <https://www.influxdata.com/high-availability/>`_.
**Installing Grafana:**
- Grafana is used to display Traffic Stats/InfluxDB data in Traffic Ops. Grafana is typically run on the same server as Traffic Stats but this is not a requirement. Grafana can be installed on any server that can access InfluxDB and be accessed by Traffic Ops. Documentation on installing Grafana can be found `here <http://docs.grafana.org/installation/>`_.
+ Grafana is used to display Traffic Stats/InfluxDB data in Traffic Ops. Grafana is typically run on the same server as Traffic Stats but this is not a requirement. Grafana can be installed on any server that can access InfluxDB and can be accessed by Traffic Ops. Documentation on installing Grafana can be found on the `Grafana website <http://docs.grafana.org/installation/>`_.
Configuration
=========================
@@ -53,25 +53,26 @@ Configuration
- *toUrl:* The URL of the Traffic Ops server used by Traffic Stats
- *influxUser:* The user to use when connecting to InfluxDB (if configured on InfluxDB, else leave default)
- *influxPassword:* That password to use when connecting to InfluxDB (if configured, else leave blank)
- - *polling interval:* The interval at which Traffic Monitor is polled and stats are stored in InfluxDB
+ - *pollingInterval:* The interval at which Traffic Monitor is polled and stats are stored in InfluxDB
- *statusToMon:* The status of Traffic Monitor to poll (poll ONLINE or OFFLINE traffic monitors)
- *seelogConfig:* The absolute path of the seelong config file
- *dailySummaryPollingInterval:* The interval, in seconds, at which Traffic Stats checks to see if daily stats need to be computed and stored.
- *cacheRetentionPolicy:* The default retention policy for cache stats
- *dsRetentionPolicy:* The default retention policy for deliveryservice stats
- *dailySummaryRetentionPolicy:* The retention policy to be used for the daily stats
+ - *influxUrls:* An array of influxdb hosts for Traffic Stats to write stats to.
**Configuring InfluxDB:**
- It is HIGHLY recommended that InfluxDB be configured for clustering. Documentation on clustering configuration can be found on the clustering page of the `InfluxDB Website <https://docs.influxdata.com/influxdb/latest/clustering/>`_.
+ As mentioned above, it is recommended that InfluxDb be running in some sort of high availability configuration. There are several ways to achieve high availabilty so it is best to consult the high availability options on the `InfuxDB website <https://www.influxdata.com/high-availability/>`_.
- Once InfluxDB is installed and clustering is configured, Databases and Retention Policies need to be created. Traffic Stats writes to three different databases: cache_stats, deliveryservice_stats, and daily_stats. More information about the databases and what data is stored in each can be found on the `overview <../overview/traffic_stats.html>`_ page.
+ Once InfluxDB is installed and configured, databases and retention policies need to be created. Traffic Stats writes to three different databases: cache_stats, deliveryservice_stats, and daily_stats. More information about the databases and what data is stored in each can be found on the `overview <../overview/traffic_stats.html>`_ page.
- To easily create databases, retention policies, and continuous queries, run create_ts_databases.go from the influxdb_tools directory. See the `InfluxDb Tools <traffic_stats.html#influxdb-tools>`_ section below for more information.
+ To easily create databases, retention policies, and continuous queries, run create_ts_databases from the /opt/traffic_stats/influxdb_tools directory on your Traffic Stats server. See the `InfluxDb Tools <traffic_stats.html#influxdb-tools>`_ section below for more information.
**Configuring Grafana:**
- In Traffic Ops the Health -> Graph View tab can be configured to display grafana graphs using influxDb data. In order for this to work correctly, you will need two things 1) a parameter added to traffic ops with the graph URL (we will discuss later) and 2) the graphs created in grafana. See below for how to create some simple graphs in grafana. These instructions assume that InfluxDB has been installed and conifugred and that data has been written to it. If this is not true, you will not see any graphs.
+ In Traffic Ops the Health -> Graph View tab can be configured to display grafana graphs using influxDb data. In order for this to work correctly, you will need two things 1) a parameter added to traffic ops with the graph URL (more information below) and 2) the graphs created in grafana. See below for how to create some simple graphs in grafana. These instructions assume that InfluxDB has been configured and that data has been written to it. If this is not true, you will not see any graphs.
- Login to grafana as an admin user http://grafana_url:3000/login
- Choose Data Sources and then Add New
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops.txt b/docs/latest/_sources/development/traffic_ops.txt
index 520dc19..c2957a5 100644
--- a/docs/latest/_sources/development/traffic_ops.txt
+++ b/docs/latest/_sources/development/traffic_ops.txt
@@ -606,13 +606,14 @@ API 1.2 Reference
traffic_ops_api/v12/changelog
traffic_ops_api/v12/deliveryservice
traffic_ops_api/v12/deliveryservice_stats
+ traffic_ops_api/v12/division
traffic_ops_api/v12/federation
traffic_ops_api/v12/hwinfo
traffic_ops_api/v12/parameter
traffic_ops_api/v12/phys_location
traffic_ops_api/v12/profile
+ traffic_ops_api/v12/profile_parameter
traffic_ops_api/v12/influxdb
- traffic_ops_api/v12/division
traffic_ops_api/v12/region
traffic_ops_api/v12/role
traffic_ops_api/v12/server
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/asn.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/asn.txt b/docs/latest/_sources/development/traffic_ops_api/v11/asn.txt
index 8ed5d5c..bd10bb7 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/asn.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/asn.txt
@@ -25,7 +25,7 @@ ASN
/api/1.1/asns
+++++++++++++
-**GET /api/1.1/asns.json**
+**GET /api/1.1/asns**
Authentication Required: Yes
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.txt b/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.txt
index d0dd1d1..30a5732 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.txt
@@ -24,7 +24,7 @@ Cache Group
/api/1.1/cachegroups
++++++++++++++++++++
-**GET /api/1.1/cachegroups.json**
+**GET /api/1.1/cachegroups**
Authentication Required: Yes
@@ -32,62 +32,72 @@ Cache Group
**Response Properties**
- +------------------------+--------+--------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +========================+========+==========================================================================+
- | ``longitude`` | string | Longitude for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupId`` | string | Identifier that refers to the 'id' field of different Cache Group entry. |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this entry was last updated |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``typeName`` | string | The name of the type of Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``name`` | string | The name of the Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``latitude`` | string | Latitude for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``id`` | string | Local unique identifier for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``shortName`` | string | Abbreviation of the Cache Group Name |
- +------------------------+--------+--------------------------------------------------------------------------+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "longitude": "0",
- "parentCachegroupId": null,
+ "id": "21",
"lastUpdated": "2012-09-25 20:27:28",
- "typeName": "MID_LOC",
+ "latitude": "0",
+ "longitude": "0",
"name": "dc-chicago",
+ "parentCachegroupId": null,
"parentCachegroupName": null,
- "typeId": "4",
- "latitude": "0",
- "id": "21",
- "shortName": "dcchi"
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
},
{
+ "id": "22",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
"longitude": "0",
+ "name": "dc-chicago-1",
"parentCachegroupId": null,
- "lastUpdated": "2012-09-25 20:32:03",
- "typeName": "MID_LOC",
- "name": "dc-cmc",
"parentCachegroupName": null,
- "typeId": "4",
- "latitude": "0",
- "id": "22",
- "shortName": "dccmc"
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
}
],
}
|
-**GET /api/1.1/cachegroups/trimmed.json**
+**GET /api/1.1/cachegroups/trimmed**
Authentication Required: Yes
@@ -116,7 +126,67 @@ Cache Group
|
-**GET /api/1.1/cachegroup/:parameter_id/parameter.json**
+**GET /api/1.1/cachegroups/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ }
+ ],
+ }
+
+|
+
+
+**GET /api/1.1/cachegroup/:parameter_id/parameter**
Authentication Required: Yes
@@ -160,7 +230,7 @@ Cache Group
}
-**GET /api/1.1/cachegroupparameters.json**
+**GET /api/1.1/cachegroupparameters**
Authentication Required: Yes
@@ -207,7 +277,7 @@ Cache Group
|
-**GET /api/1.1/cachegroups/:parameter_id/parameter/available.json**
+**GET /api/1.1/cachegroups/:parameter_id/parameter/available**
Authentication Required: Yes
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v11/cdn.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/cdn.txt b/docs/latest/_sources/development/traffic_ops_api/v11/cdn.txt
index 001398b..1173c84 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v11/cdn.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/cdn.txt
@@ -24,7 +24,7 @@ CDN
/api/1.1/cdns
+++++++++++++
-**GET /api/1.1/cdns.json**
+**GET /api/1.1/cdns**
Authentication Required: Yes
@@ -32,50 +32,119 @@ CDN
**Response Properties**
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``name`` | string | CDN name. |
- +------------------+--------+-------------------------------------------------+
- | ``id`` | int | CDN id. |
- +------------------+--------+-------------------------------------------------+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
**Response Example** ::
{
"response": [
{
+ "id": "1"
"name": "over-the-top",
- "id": 1
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": true,
+ "lastUpdated": "2014-10-02 08:22:43"
}
]
}
|
-**GET /api/1.1/cdns/name/:name.json**
+**GET /api/1.1/cdns/:id**
Authentication Required: Yes
Role(s) Required: None
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | CDN id. |
+ +-----------+----------+---------------------------------------------+
+
**Response Properties**
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``name`` | string | CDN name. |
- +------------------+--------+-------------------------------------------------+
- | ``id`` | int | CDN id. |
- +------------------+--------+-------------------------------------------------+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "name": "over-the-top",
- "id": 1
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/cdns/name/:name**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``name`` | yes | CDN name. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
}
]
}
@@ -85,7 +154,7 @@ CDN
Health
++++++
-**GET /api/1.1/cdns/health.json**
+**GET /api/1.1/cdns/health**
Retrieves the health of all locations (cache groups) for all CDNs.
@@ -136,7 +205,7 @@ Health
|
-**GET /api/1.1/cdns/:name/health.json**
+**GET /api/1.1/cdns/:name/health**
Retrieves the health of all locations (cache groups) for a given CDN.
@@ -196,7 +265,7 @@ Health
|
-**GET /api/1.1/cdns/usage/overview.json**
+**GET /api/1.1/cdns/usage/overview**
Retrieves the high-level CDN usage metrics.
@@ -228,7 +297,7 @@ Health
}
-**GET /api/1.1/cdns/capacity.json**
+**GET /api/1.1/cdns/capacity**
Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.
@@ -268,7 +337,7 @@ Health
Routing
+++++++
-**GET /api/1.1/cdns/routing.json**
+**GET /api/1.1/cdns/routing**
Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.
@@ -314,7 +383,7 @@ Routing
Metrics
+++++++
-**GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end.json**
+**GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end**
Retrieves edge metrics of one or all locations (cache groups).
@@ -403,7 +472,7 @@ Metrics
Domains
+++++++
-**GET /api/1.1/cdns/domains.json**
+**GET /api/1.1/cdns/domains**
Authentication Required: Yes
@@ -453,7 +522,7 @@ Domains
Topology
++++++++
-**GET /api/1.1/cdns/:cdn_name/configs.json**
+**GET /api/1.1/cdns/:cdn_name/configs**
Retrieves CDN config information based upon the provided cdn name.
@@ -489,7 +558,7 @@ Topology
|
-**GET /api/1.1/cdns/:name/configs/monitoring.json**
+**GET /api/1.1/cdns/:name/configs/monitoring**
Retrieves CDN monitoring information.
@@ -627,7 +696,7 @@ Topology
|
-**GET /api/1.1/cdns/:name/configs/routing.json**
+**GET /api/1.1/cdns/:name/configs/routing**
Retrieves CDN routing information.
@@ -844,7 +913,7 @@ Topology
DNSSEC Keys
+++++++++++
-**GET /api/1.1/cdns/name/:name/dnsseckeys.json**
+**GET /api/1.1/cdns/name/:name/dnsseckeys**
Gets a list of dnsseckeys for CDN and all associated Delivery Services.
Before returning response to user, check to make sure keys aren't expired. If they are expired, generate new ones.
@@ -932,7 +1001,7 @@ DNSSEC Keys
|
-**GET /api/1.1/cdns/name/:name/dnsseckeys/delete.json**
+**GET /api/1.1/cdns/name/:name/dnsseckeys/delete**
Delete dnssec keys for a cdn and all associated delivery services.
[15/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/basics/caching_proxies.html
----------------------------------------------------------------------
diff --git a/docs/latest/basics/caching_proxies.html b/docs/latest/basics/caching_proxies.html
index d086be5..f544c4d 100644
--- a/docs/latest/basics/caching_proxies.html
+++ b/docs/latest/basics/caching_proxies.html
@@ -82,7 +82,7 @@
<li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Caching Proxies</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
</ul>
</li>
@@ -222,16 +222,16 @@ cache is: <code class="docutils literal"><span class="pre">http://www-origin-cac
<p class="first admonition-title">Note</p>
<p class="last">In the previous example minimal headers were shown on both the request and response. In the examples that follow, the origin server response is more realistic.</p>
</div>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
<p>The client is given the URL <code class="docutils literal"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> (note the different hostname) and when attempting to obtain that URL, the following occurs:</p>
@@ -241,8 +241,8 @@ Content-Type: text/html; charset=UTF-8
<li><p class="first">Similar to the previous case, the LDNS server resolves the name <code class="docutils literal"><span class="pre">www-origin-cache.cdn.com</span></code> to an IPv4 address, in this example, this address is 55.44.33.22.</p>
</li>
<li><p class="first">The client opens a TCP connection from a random port locally, to port 80 (the HTTP default) on 55.44.33.22, and sends the following:</p>
-<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
-Host: www-origin-cache.cdn.com
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">-</span><span class="n">origin</span><span class="o">-</span><span class="n">cache</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
@@ -255,38 +255,38 @@ Host: www-origin-cache.cdn.com
<blockquote>
<div><ol class="arabic">
<li><p class="first">The proxy uses DNS to get the IPv4 address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>, connect to it on port 80, and sends:</p>
-<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
-Host: www.origin.com
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
<li><p class="first">The origin server responds with the headers and content as shown:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p class="first">The proxy sends the origin response on to the client adding a <code class="docutils literal"><span class="pre">Via:</span></code> header (and maybe others):</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-Age: 0
-Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
-Server: ATS/4.2.1
-
- <html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+<span class="n">Age</span><span class="p">:</span> <span class="mi">0</span>
+<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
+
+ <span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</li>
@@ -295,18 +295,18 @@ Server: ATS/4.2.1
<p>6b. If it <em>is</em> in the cache:</p>
<blockquote>
<div><p>The proxy responds to the client with the previously retrieved result:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-Age: 39711
-Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
-Server: ATS/4.2.1
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+<span class="n">Age</span><span class="p">:</span> <span class="mi">39711</span>
+<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</div></blockquote>
@@ -331,7 +331,7 @@ client obtains, and is unaware of the proxy in the middle.</div></blockquote>
<li>To retrieve <code class="docutils literal"><span class="pre">http://www.origin.com/foo/bar/fun.html</span></code> URL, the client connects to 99.88.77.66 on port 8080 and sends:</li>
</ol>
<blockquote>
-<div><div class="highlight-python"><div class="highlight"><pre>GET http://www.origin.com/foo/bar/fun.html HTTP/1.1
+<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
</pre></div>
</div>
<div class="admonition note">
@@ -346,38 +346,38 @@ client obtains, and is unaware of the proxy in the middle.</div></blockquote>
<blockquote>
<div><ol class="arabic">
<li><p class="first">The proxy uses DNS to obtain the IPv4 address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>, connects to it on port 80, and sends:</p>
-<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
-Host: www.origin.com
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
<li><p class="first">The origin server responds with the headers and content as shown below:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p class="first">The proxy sends this on to the client adding a <code class="docutils literal"><span class="pre">Via:</span></code> header (and maybe others):</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-Age: 0
-Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
-Server: ATS/4.2.1
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+<span class="n">Age</span><span class="p">:</span> <span class="mi">0</span>
+<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</li>
@@ -386,18 +386,18 @@ Server: ATS/4.2.1
<p>4b. If it <em>is</em> in the cache:</p>
<blockquote>
<div><p>The proxy responds to the client with the previously retrieved result:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-Age: 99711
-Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
-Server: ATS/4.2.1
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+<span class="n">Age</span><span class="p">:</span> <span class="mi">99711</span>
+<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</div></blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/basics/content_delivery_networks.html
----------------------------------------------------------------------
diff --git a/docs/latest/basics/content_delivery_networks.html b/docs/latest/basics/content_delivery_networks.html
index a36d62c..5351d03 100644
--- a/docs/latest/basics/content_delivery_networks.html
+++ b/docs/latest/basics/content_delivery_networks.html
@@ -80,7 +80,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="">Content Delivery Networks</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/basics/http_11.html
----------------------------------------------------------------------
diff --git a/docs/latest/basics/http_11.html b/docs/latest/basics/http_11.html
index aa838f3..3509cae 100644
--- a/docs/latest/basics/http_11.html
+++ b/docs/latest/basics/http_11.html
@@ -81,7 +81,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">HTTP 1.1</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
</ul>
@@ -201,17 +201,17 @@
</div></blockquote>
<ol class="arabic" start="3">
<li><p class="first">The client opens a TCP connection from a random port locally to port 80 (the HTTP default) on 44.33.22.11, and sends this (showing the minimum HTTP 1.1 request, typically there are additional headers):</p>
-<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
-Host: www.origin.com
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
<li><p class="first">The server at <code class="docutils literal"><span class="pre">www.origin.com</span></code> looks up the Host: header to match that to a configuration section, usually referred to as a virtual host section. If the Host: header and configuration section match, the search continues for the content of the path <code class="docutils literal"><span class="pre">/foo/bar/fun.html</span></code>, in the example, this is a file that contains <code class="docutils literal"><span class="pre"><html><body>This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">fun</span> <span class="pre">file</body></html></span></code>, so the server responds with the following:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Content-Type: text/html; charset=UTF-8
-Content-Length: 45
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
-<html><body>This is a fun file</body></html>
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/basics/index.html
----------------------------------------------------------------------
diff --git a/docs/latest/basics/index.html b/docs/latest/basics/index.html
index e792271..d4921fa 100644
--- a/docs/latest/basics/index.html
+++ b/docs/latest/basics/index.html
@@ -78,7 +78,7 @@
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="">CDN Basics</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">CDN Basics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/index.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/index.html b/docs/latest/development/index.html
index 83af885..42ef17a 100644
--- a/docs/latest/development/index.html
+++ b/docs/latest/development/index.html
@@ -116,7 +116,7 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="">Developer’s Guide</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_monitor.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_monitor.html b/docs/latest/development/traffic_monitor.html
index 55c4a6b..fa3c0f4 100644
--- a/docs/latest/development/traffic_monitor.html
+++ b/docs/latest/development/traffic_monitor.html
@@ -121,7 +121,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Monitor</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
</ul>
@@ -318,7 +318,7 @@
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">�</a></h2>
-<p><a class="reference internal" href="traffic_monitor/traffic_monitor_api.html#reference-tm-api"><em>Traffic Monitor APIs</em></a></p>
+<p><a class="reference internal" href="traffic_monitor/traffic_monitor_api.html#reference-tm-api"><span class="std std-ref">Traffic Monitor APIs</span></a></p>
<div class="toctree-wrapper compound">
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops.html b/docs/latest/development/traffic_ops.html
index cfddbd4..fb939a1 100644
--- a/docs/latest/development/traffic_ops.html
+++ b/docs/latest/development/traffic_ops.html
@@ -118,7 +118,7 @@
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
@@ -264,7 +264,7 @@
<div class="section" id="perl-formatting-conventions">
<h2>Perl Formatting Conventions<a class="headerlink" href="#perl-formatting-conventions" title="Permalink to this headline">�</a></h2>
<p>Perl tidy is for use in code formatting. See the following config file for formatting conventions.</p>
-<div class="highlight-python"><div class="highlight"><pre>edit a file called $HOME/.perltidyrc
+<div class="highlight-default"><div class="highlight"><pre><span></span>edit a file called $HOME/.perltidyrc
-l=156
-et=4
@@ -350,7 +350,7 @@ environment.</td>
<li>Install the local dependencies using Carton (cpanfile).</li>
</ol>
<blockquote>
-<div><div class="highlight-python"><div class="highlight"><pre>$ cd traffic_ops/app
+<div><div class="highlight-default"><div class="highlight"><pre><span></span>$ cd traffic_ops/app
$ carton
</pre></div>
</div>
@@ -360,7 +360,7 @@ $ carton
</ol>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>master $ mysql
+<div class="highlight-default"><div class="highlight"><pre><span></span>master $ mysql
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 305
Server version: 5.6.19 Homebrew
@@ -391,7 +391,7 @@ mysql> grant all on to_integration.* to 'to_user'@'localhost'
<div class="line"><br /></div>
</div>
<p>Running the the admin.pl script in setup mode should look like this:</p>
-<div class="highlight-python"><div class="highlight"><pre>master $ db/admin.pl --env=development setup
+<div class="highlight-default"><div class="highlight"><pre><span></span>master $ db/admin.pl --env=development setup
Using database.conf: conf/development/database.conf
Using database.conf: conf/development/database.conf
Using database.conf: conf/development/database.conf
@@ -424,9 +424,9 @@ Warning: Using a password on the command line interface can be insecure.
</li>
</ol>
<blockquote>
-<div><div class="highlight-python"><div class="highlight"><pre>[2015-02-24 10:44:34,991] [INFO] Listening at "http://*:3000".
+<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="mi">2015</span><span class="o">-</span><span class="mi">02</span><span class="o">-</span><span class="mi">24</span> <span class="mi">10</span><span class="p">:</span><span class="mi">44</span><span class="p">:</span><span class="mi">34</span><span class="p">,</span><span class="mi">991</span><span class="p">]</span> <span class="p">[</span><span class="n">INFO</span><span class="p">]</span> <span class="n">Listening</span> <span class="n">at</span> <span class="s2">"http://*:3000"</span><span class="o">.</span>
-Server available at http://127.0.0.1:3000.
+<span class="n">Server</span> <span class="n">available</span> <span class="n">at</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span><span class="p">:</span><span class="mf">3000.</span>
</pre></div>
</div>
</div></blockquote>
@@ -486,14 +486,14 @@ Server available at http://127.0.0.1:3000.
</ol>
<blockquote>
<div>These allow you to add statistic sources for the graph views and APIs.</div></blockquote>
-<p>Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see <a class="reference internal" href="../admin/traffic_ops_extensions.html#admin-to-ext-script"><em>Managing Traffic Ops Extensions</em></a>.</p>
+<p>Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see <a class="reference internal" href="../admin/traffic_ops_extensions.html#admin-to-ext-script"><span class="std std-ref">Managing Traffic Ops Extensions</span></a>.</p>
<div class="section" id="check-extensions">
<h3>Check Extensions<a class="headerlink" href="#check-extensions" title="Permalink to this headline">�</a></h3>
<p>In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the “Health->Server Checks” view and that usually run periodically out of cron.</p>
<p>It is the responsibility of the check extension script to iterate over the servers it wants to check and post the results.</p>
<p>An example script might proceed by logging into the Traffic Ops server using the HTTPS base_url provided on the command line. The script is hardcoded with an auth token that is also provisioned in the Traffic Ops User database. This token allows the script to obtain a cookie used in later communications with the Traffic Ops API. The script then obtains a list of all caches to be polled by accessing Traffic Ops’ <code class="docutils literal"><span class="pre">/api/1.1/servers.json</span></code> REST target. This list is walked, running a command to gather the stats from that cache. For some extensions, an HTTP GET request might be made to the ATS astats plugin, while for others the cache might be pinged, or a command run over SSH. The results are then compiled into a numeric or boolean result and the script POSTs tha result back to the Traffic Ops <code class="docutils literal"><span class="pre">/api/1.1/servercheck/</span></code> target.</p>
<p>A check extension can have a column of <img alt="checkmark" src="../_images/good1.png" />‘s and <img alt="X" src="../_images/bad1.png" />‘s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below:</p>
-<div class="highlight-python"><div class="highlight"><pre>Script here.
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Script</span> <span class="n">here</span><span class="o">.</span>
</pre></div>
</div>
<p>Check Extension scripts are located in the $TO_HOME/bin/checks directory.</p>
@@ -508,7 +508,7 @@ Server available at http://127.0.0.1:3000.
<dt><strong>Maximum Transmission Check - MTU</strong></dt>
<dd>Checks if the Traffic Ops host (if that is the one running the check) can send and receive 8192 size packets to the <code class="docutils literal"><span class="pre">ip_address</span></code> of the server in the server table.</dd>
<dt><strong>Operational Readiness Check - ORT</strong></dt>
-<dd>See <a class="reference internal" href="../admin/traffic_server.html#reference-traffic-ops-ort"><em>Configuring Traffic Server</em></a> for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.</dd>
+<dd>See <a class="reference internal" href="../admin/traffic_server.html#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a> for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.</dd>
<dt><strong>Ping Check - 10G, ILO, 10G6, FQDN</strong></dt>
<dd><p class="first">The bin/checks/ToPingCheck.pl is to check basic IP connectivity, and in the default setup it checks IP connectivity to the following:</p>
<dl class="last docutils">
@@ -541,7 +541,7 @@ Server available at http://127.0.0.1:3000.
<div class="section" id="extension-directories">
<h3>Extension Directories<a class="headerlink" href="#extension-directories" title="Permalink to this headline">�</a></h3>
<p>PERL5LIB Example Configuration:</p>
-<div class="highlight-python"><div class="highlight"><pre>export PERL5LIB=/opt/traffic_ops_extensions/private/lib/Extensions:/opt/traffic_ops/app/lib/Extensions/TrafficStats
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops_extensions</span><span class="o">/</span><span class="n">private</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="o">/</span><span class="n">TrafficStats</span>
</pre></div>
</div>
</div>
@@ -568,9 +568,9 @@ Extensions::YourCustomExtension</p>
<div class="section" id="response-structure">
<h3>Response Structure<a class="headerlink" href="#response-structure" title="Permalink to this headline">�</a></h3>
<p>All successful responses have the following structure:</p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": <JSON object with main response>,
-}
+<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="o"><</span><span class="n">JSON</span> <span class="nb">object</span> <span class="k">with</span> <span class="n">main</span> <span class="n">response</span><span class="o">></span><span class="p">,</span>
+<span class="p">}</span>
</pre></div>
</div>
<p>To make the documentation easier to read, only the <code class="docutils literal"><span class="pre"><JSON</span> <span class="pre">object</span> <span class="pre">with</span> <span class="pre">main</span> <span class="pre">response></span></code> is documented, even though the response and version fields are always present.</p>
@@ -583,7 +583,7 @@ Extensions::YourCustomExtension</p>
<li>Pass the mojolicious cookie value, along with any subsequent calls to an authenticated API endpoint.</li>
</ol>
<p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+<div class="highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
{"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
[jvd@laika ~]$
[jvd@laika ~]$ curl -v -H "Accept: application/json" -v -X POST --data '{ "u":"admin", "p":"secret_passwd" }' http://localhost:3000/api/1.1/user/login
@@ -658,7 +658,7 @@ Extensions::YourCustomExtension</p>
<dl class="docutils">
<dt>401 Unauthorized</dt>
<dd><p class="first">When you don’t supply the right cookie, this is the response.</p>
-<div class="last highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+<div class="last highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
* Hostname was NOT found in DNS cache
* Trying ::1...
* connect to ::1 port 3000 failed: Connection refused
@@ -690,7 +690,7 @@ Extensions::YourCustomExtension</p>
</dd>
<dt>404 Not Found</dt>
<dd><p class="first">When the resource (path) is non existent Traffic Ops returns a 404:</p>
-<div class="last highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json
+<div class="last highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json
* Hostname was NOT found in DNS cache
* Trying ::1...
* connect to ::1 port 3000 failed: Connection refused
@@ -724,7 +724,7 @@ Extensions::YourCustomExtension</p>
</dd>
<dt>500 Internal Server Error</dt>
<dd><p class="first">When you are asking for a correct path, but the database doesn’t match, it returns a 500:</p>
-<div class="highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json
+<div class="highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json
* Hostname was NOT found in DNS cache
* Trying ::1...
* connect to ::1 port 3000 failed: Connection refused
@@ -803,13 +803,14 @@ Extensions::YourCustomExtension</p>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/changelog.html">Change Logs</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice.html">Delivery Service</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice_stats.html">Delivery Service Statistics</a></li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/division.html">Divisions</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/federation.html">Federation</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/hwinfo.html">Hardware Info</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/parameter.html">Parameter</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/phys_location.html">Physical Location</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/profile.html">Profiles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/profile_parameter.html">Profile parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/influxdb.html">InfluxDB</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/division.html">Divisions</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/region.html">Regions</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/role.html">Roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/server.html">Server</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/routes.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/routes.html b/docs/latest/development/traffic_ops_api/routes.html
index 2a8e150..b8d9efd 100644
--- a/docs/latest/development/traffic_ops_api/routes.html
+++ b/docs/latest/development/traffic_ops_api/routes.html
@@ -224,16 +224,16 @@ table.docutils col:nth-child(3) {
</thead>
<tbody valign="top">
<tr class="row-even"><td>/asns</td>
-<td><a class="reference internal" href="v11/asn.html#to-api-v11-asns-route"><em>/api/1.1/asns</em></a></td>
-<td><a class="reference internal" href="v12/asn.html#to-api-v12-asns-route"><em>/api/1.2/asns</em></a></td>
+<td><a class="reference internal" href="v11/asn.html#to-api-v11-asns-route"><span class="std std-ref">/api/1.1/asns</span></a></td>
+<td><a class="reference internal" href="v12/asn.html#to-api-v12-asns-route"><span class="std std-ref">/api/1.2/asns</span></a></td>
</tr>
<tr class="row-odd"><td>/availableds</td>
-<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><em>/api/1.1/deliveryservices</em></a></td>
-<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><em>/api/1.2/deliveryservices</em></a></td>
+<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td>
+<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td>
</tr>
<tr class="row-even"><td><em>Not Implemented</em></td>
<td><em>Not Implemented</em></td>
-<td><a class="reference internal" href="v12/cache_stats.html#to-api-v12-cache-stats-route"><em>/api/1.2/cache_stats</em></a></td>
+<td><a class="reference internal" href="v12/cache_stats.html#to-api-v12-cache-stats-route"><span class="std std-ref">/api/1.2/cache_stats</span></a></td>
</tr>
<tr class="row-odd"><td>/datacrans</td>
<td>/api/1.1/crans.json</td>
@@ -244,8 +244,8 @@ table.docutils col:nth-child(3) {
<td>/api/1.2/crans.json</td>
</tr>
<tr class="row-odd"><td>/datadeliveryservice</td>
-<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><em>/api/1.1/deliveryservices</em></a></td>
-<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><em>/api/1.2/deliveryservices</em></a></td>
+<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td>
+<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td>
</tr>
<tr class="row-even"><td>/datadeliveryserviceserver</td>
<td>/api/1.1/deliveryserviceserver.json</td>
@@ -257,11 +257,11 @@ table.docutils col:nth-child(3) {
</tr>
<tr class="row-even"><td><em>Not Implemented</em></td>
<td><em>Not Implemented</em></td>
-<td><a class="reference internal" href="v12/deliveryservice_stats.html#to-api-v12-ds-stats-route"><em>/api/1.2/deliveryservice_stats</em></a></td>
+<td><a class="reference internal" href="v12/deliveryservice_stats.html#to-api-v12-ds-stats-route"><span class="std std-ref">/api/1.2/deliveryservice_stats</span></a></td>
</tr>
<tr class="row-odd"><td>/datahwinfo</td>
-<td><a class="reference internal" href="v11/hwinfo.html#to-api-v11-hwinfo-route"><em>/api/1.1/hwinfo</em></a></td>
-<td><a class="reference internal" href="v12/hwinfo.html#to-api-v12-hwinfo-route"><em>/api/1.2/hwinfo</em></a></td>
+<td><a class="reference internal" href="v11/hwinfo.html#to-api-v11-hwinfo-route"><span class="std std-ref">/api/1.1/hwinfo</span></a></td>
+<td><a class="reference internal" href="v12/hwinfo.html#to-api-v12-hwinfo-route"><span class="std std-ref">/api/1.2/hwinfo</span></a></td>
</tr>
<tr class="row-even"><td>/datalinks</td>
<td>/api/1.1/deliveryserviceserver.json</td>
@@ -272,86 +272,86 @@ table.docutils col:nth-child(3) {
<td>/api/1.2/deliveryserviceserver.json</td>
</tr>
<tr class="row-even"><td>/datalogs</td>
-<td><a class="reference internal" href="v11/changelog.html#to-api-v11-change-logs-route"><em>/api/1.1/logs</em></a></td>
-<td><a class="reference internal" href="v12/changelog.html#to-api-v12-change-logs-route"><em>/api/1.2/logs</em></a></td>
+<td><a class="reference internal" href="v11/changelog.html#to-api-v11-change-logs-route"><span class="std std-ref">/api/1.1/logs</span></a></td>
+<td><a class="reference internal" href="v12/changelog.html#to-api-v12-change-logs-route"><span class="std std-ref">/api/1.2/logs</span></a></td>
</tr>
<tr class="row-odd"><td>/datalocation/orderby/id</td>
-<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><em>/api/1.1/cachegroups</em></a></td>
-<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><em>/api/1.2/cachegroups</em></a></td>
+<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td>
+<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td>
</tr>
<tr class="row-even"><td>/datalocationparameters</td>
-<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><em>/api/1.1/cachegroups</em></a></td>
-<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><em>/api/1.2/cachegroups</em></a></td>
+<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td>
+<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td>
</tr>
<tr class="row-odd"><td>/dataparameter</td>
-<td><a class="reference internal" href="v11/parameter.html#to-api-v11-parameters-route"><em>/api/1.1/parameters</em></a></td>
-<td><a class="reference internal" href="v12/parameter.html#to-api-v12-parameters-route"><em>/api/1.2/parameters</em></a></td>
+<td><a class="reference internal" href="v11/parameter.html#to-api-v11-parameters-route"><span class="std std-ref">/api/1.1/parameters</span></a></td>
+<td><a class="reference internal" href="v12/parameter.html#to-api-v12-parameters-route"><span class="std std-ref">/api/1.2/parameters</span></a></td>
</tr>
<tr class="row-even"><td>/dataparameter/:parameter</td>
<td>/api/1.1/parameters/profile/:parameter.json</td>
<td>/api/1.2/parameters/profile/:parameter.json</td>
</tr>
<tr class="row-odd"><td>/dataphys_location</td>
-<td><a class="reference internal" href="v11/phys_location.html#to-api-v11-phys-loc-route"><em>/api/1.1/phys_locations</em></a></td>
-<td><a class="reference internal" href="v12/phys_location.html#to-api-v12-phys-loc-route"><em>/api/1.2/phys_locations</em></a></td>
+<td><a class="reference internal" href="v11/phys_location.html#to-api-v11-phys-loc-route"><span class="std std-ref">/api/1.1/phys_locations</span></a></td>
+<td><a class="reference internal" href="v12/phys_location.html#to-api-v12-phys-loc-route"><span class="std std-ref">/api/1.2/phys_locations</span></a></td>
</tr>
<tr class="row-even"><td><p class="first">/dataprofile</p>
<p class="last">/dataprofile/orderby/name</p>
</td>
-<td><a class="reference internal" href="v11/profile.html#to-api-v11-profiles-route"><em>/api/1.1/profiles</em></a></td>
-<td><a class="reference internal" href="v12/profile.html#to-api-v12-profiles-route"><em>/api/1.2/profiles</em></a></td>
+<td><a class="reference internal" href="v11/profile.html#to-api-v11-profiles-route"><span class="std std-ref">/api/1.1/profiles</span></a></td>
+<td><a class="reference internal" href="v12/profile.html#to-api-v12-profiles-route"><span class="std std-ref">/api/1.2/profiles</span></a></td>
</tr>
<tr class="row-odd"><td>/dataregion</td>
-<td><a class="reference internal" href="v11/region.html#to-api-v11-regions-route"><em>/api/1.1/regions</em></a></td>
-<td><a class="reference internal" href="v12/region.html#to-api-v12-regions-route"><em>/api/1.2/regions</em></a></td>
+<td><a class="reference internal" href="v11/region.html#to-api-v11-regions-route"><span class="std std-ref">/api/1.1/regions</span></a></td>
+<td><a class="reference internal" href="v12/region.html#to-api-v12-regions-route"><span class="std std-ref">/api/1.2/regions</span></a></td>
</tr>
<tr class="row-even"><td>/datarole</td>
-<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><em>/api/1.1/roles</em></a></td>
-<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><em>/api/1.2/roles</em></a></td>
+<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td>
+<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td>
</tr>
<tr class="row-odd"><td>/datarole/orderby/:field</td>
-<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><em>/api/1.1/roles</em></a></td>
-<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><em>/api/1.2/roles</em></a></td>
+<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td>
+<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td>
</tr>
<tr class="row-even"><td>/dataserver</td>
-<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><em>/api/1.1/servers</em></a></td>
-<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><em>/api/1.2/servers</em></a></td>
+<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td>
+<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td>
</tr>
<tr class="row-odd"><td>/dataserver/orderby/:field</td>
-<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><em>/api/1.1/servers</em></a></td>
-<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><em>/api/1.2/servers</em></a></td>
+<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td>
+<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td>
</tr>
<tr class="row-even"><td>/dataserverdetail/select/:hostname</td>
<td>/api/1.1/servers/hostname/:hostname/details.json</td>
<td>/api/1.2/servers/hostname/:hostname/details.json</td>
</tr>
<tr class="row-odd"><td>/datastaticdnsentry</td>
-<td><a class="reference internal" href="v11/static_dns.html#to-api-v11-static-dns-route"><em>/api/1.1/staticdnsentries</em></a></td>
-<td><a class="reference internal" href="v12/static_dns.html#to-api-v12-static-dns-route"><em>/api/1.2/staticdnsentries</em></a></td>
+<td><a class="reference internal" href="v11/static_dns.html#to-api-v11-static-dns-route"><span class="std std-ref">/api/1.1/staticdnsentries</span></a></td>
+<td><a class="reference internal" href="v12/static_dns.html#to-api-v12-static-dns-route"><span class="std std-ref">/api/1.2/staticdnsentries</span></a></td>
</tr>
<tr class="row-even"><td>/datastatus</td>
-<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><em>/api/1.1/statuses</em></a></td>
-<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><em>/api/1.2/statuses</em></a></td>
+<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td>
+<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td>
</tr>
<tr class="row-odd"><td>/datastatus/orderby/name</td>
-<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><em>/api/1.1/statuses</em></a></td>
-<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><em>/api/1.2/statuses</em></a></td>
+<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td>
+<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td>
</tr>
<tr class="row-even"><td>/datatype</td>
-<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><em>/api/1.1/types</em></a></td>
-<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><em>/api/1.2/types</em></a></td>
+<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td>
+<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td>
</tr>
<tr class="row-odd"><td>/datatype/orderby/:field</td>
-<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><em>/api/1.1/types</em></a></td>
-<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><em>/api/1.2/types</em></a></td>
+<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td>
+<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td>
</tr>
<tr class="row-even"><td>/datauser</td>
-<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><em>/api/1.1/users</em></a></td>
-<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><em>/api/1.2/users</em></a></td>
+<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td>
+<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td>
</tr>
<tr class="row-odd"><td>/datauser/orderby/:field</td>
-<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><em>/api/1.1/users</em></a></td>
-<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><em>/api/1.2/users</em></a></td>
+<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td>
+<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td>
</tr>
</tbody>
</table>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/asn.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/asn.html b/docs/latest/development/traffic_ops_api/v11/asn.html
index f0dc567..9172657 100644
--- a/docs/latest/development/traffic_ops_api/v11/asn.html
+++ b/docs/latest/development/traffic_ops_api/v11/asn.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-asn"></span><h1>ASN<a class="headerlink" href="#asn" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-asns">
<span id="to-api-v11-asns-route"></span><h2>/api/1.1/asns<a class="headerlink" href="#api-1-1-asns" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/asns.json</strong></p>
+<p><strong>GET /api/1.1/asns</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -231,20 +231,20 @@
</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">"asns"</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="s2">"asns"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span>
- <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7015"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</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">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"28"</span><span class="p">,</span>
- <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7016"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-pa-pittsburgh"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
[22/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/asn.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/asn.txt b/docs/latest/_sources/development/traffic_ops_api/v12/asn.txt
index 4cdbd61..fb45a07 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/asn.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/asn.txt
@@ -25,7 +25,7 @@ ASN
/api/1.2/asns
+++++++++++++
-**GET /api/1.2/asns.json**
+**GET /api/1.2/asns**
Authentication Required: Yes
@@ -36,13 +36,15 @@ ASN
+------------------+--------+-------------------------------------------------------------------------+
| Parameter | Type | Description |
+==================+========+=========================================================================+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+------------------+--------+-------------------------------------------------------------------------+
- | ``id`` | string | Local unique identifier for the ASN |
+ | ``id`` | string | Local unique identifier for the ASN |
+------------------+--------+-------------------------------------------------------------------------+
- | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+ | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+------------------+--------+-------------------------------------------------------------------------+
- | ``cachegroup`` | string | Related cachegroup name |
+ | ``cachegroup`` | string | Related cachegroup name |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | Related cachegroup id |
+------------------+--------+-------------------------------------------------------------------------+
**Response Example** ::
@@ -53,15 +55,139 @@ ASN
"lastUpdated": "2012-09-17 21:41:22",
"id": "27",
"asn": "7015",
- "cachegroup": "us-ma-woburn"
+ "cachegroup": "us-ma-woburn",
+ "cachegroupId": "27",
},
{
"lastUpdated": "2012-09-17 21:41:22",
"id": "28",
"asn": "7016",
- "cachegroup": "us-pa-pittsburgh"
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "13"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/asns/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | ASN id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``id`` | string | Local unique identifier for the ASN |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroup`` | string | Related cachegroup name |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | Related cachegroup id |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "7016",
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "13"
}
]
}
|
+
+**PUT /api/1.2/asns/{:id}**
+
+ Allows user to edit an ASN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | ASN id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``asn`` | string | ASN |
+ +-------------------+--------+-------------------------------------------------+
+ | ``cachegroupId`` | string | The cachegroup the ASN belongs to |
+ +-------------------+--------+-------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "asn": "99",
+ "cachegroupId": "177"
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+=================================================+
+ | ``response`` | hash | The details of the update, if success. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | CDN name. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>id`` | int | CDN id. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "99",
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "177"
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was updated."
+ }
+ ]
+ }
+
+|
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt b/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt
index 08935d6..5e6dc06 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt
@@ -24,7 +24,7 @@ Cache Group
/api/1.2/cachegroups
++++++++++++++++++++
-**GET /api/1.2/cachegroups.json**
+**GET /api/1.1/cachegroups**
Authentication Required: Yes
@@ -32,67 +32,77 @@ Cache Group
**Response Properties**
- +------------------------+--------+--------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +========================+========+==========================================================================+
- | ``longitude`` | string | Longitude for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupId`` | string | Identifier that refers to the 'id' field of different Cache Group entry. |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this entry was last updated |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``typeName`` | string | The type name of Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``name`` | string | The name of the Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``latitude`` | string | Latitude for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``id`` | string | Local unique identifier for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``shortName`` | string | Abbreviation of the Cache Group Name |
- +------------------------+--------+--------------------------------------------------------------------------+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "longitude": "0",
- "parentCachegroupId": null,
+ "id": "21",
"lastUpdated": "2012-09-25 20:27:28",
- "typeName": "MID_LOC",
+ "latitude": "0",
+ "longitude": "0",
"name": "dc-chicago",
+ "parentCachegroupId": null,
"parentCachegroupName": null,
- "typeId": "4",
- "latitude": "0",
- "id": "21",
- "shortName": "dcchi"
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
},
{
+ "id": "22",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
"longitude": "0",
+ "name": "dc-chicago-1",
"parentCachegroupId": null,
- "lastUpdated": "2012-09-25 20:32:03",
- "typeName": "MID_LOC",
- "name": "dc-cmc",
"parentCachegroupName": null,
- "typeId": "4",
- "latitude": "0",
- "id": "22",
- "shortName": "dccmc"
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
}
],
}
|
-**GET /api/1.2/cachegroups/trimmed.json**
+**GET /api/1.2/cachegroups/trimmed**
Authentication Required: Yes
- Role(s) Required Required: None
-
+ Role(s) Required: None
+
**Response Properties**
+----------------------+--------+------------------------------------------------+
@@ -116,7 +126,67 @@ Cache Group
|
-**GET /api/1.2/cachegroup/:parameter_id/parameter.json**
+**GET /api/1.2/cachegroups/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ }
+ ],
+ }
+
+|
+
+
+**GET /api/1.2/cachegroup/:parameter_id/parameter**
Authentication Required: Yes
@@ -161,7 +231,7 @@ Cache Group
|
-**GET /api/1.2/cachegroupparameters.json**
+**GET /api/1.2/cachegroupparameters**
Authentication Required: Yes
@@ -207,7 +277,7 @@ Cache Group
|
-**GET /api/1.2/cachegroups/:parameter_id/parameter/available.json**
+**GET /api/1.2/cachegroups/:parameter_id/parameter/available**
Authentication Required: Yes
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt b/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt
index 855d2d2..9a4daac 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt
@@ -24,7 +24,7 @@ CDN
/api/1.2/cdns
+++++++++++++
-**GET /api/1.2/cdns.json**
+**GET /api/1.2/cdns**
Authentication Required: Yes
@@ -32,50 +32,119 @@ CDN
**Response Properties**
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``name`` | string | CDN name. |
- +------------------+--------+-------------------------------------------------+
- | ``id`` | int | CDN id. |
- +------------------+--------+-------------------------------------------------+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
**Response Example** ::
{
"response": [
{
+ "id": "1"
"name": "over-the-top",
- "id": 1
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": true,
+ "lastUpdated": "2014-10-02 08:22:43"
}
]
}
|
-**GET /api/1.2/cdns/name/:name.json**
+**GET /api/1.2/cdns/:id**
Authentication Required: Yes
Role(s) Required: None
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | CDN id. |
+ +-----------+----------+---------------------------------------------+
+
**Response Properties**
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``name`` | string | CDN name. |
- +------------------+--------+-------------------------------------------------+
- | ``id`` | int | CDN id. |
- +------------------+--------+-------------------------------------------------+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "name": "over-the-top",
- "id": 1
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/cdns/name/:name**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``name`` | yes | CDN name. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
}
]
}
@@ -268,7 +337,7 @@ Health
.. _to-api-v12-cdn-health-route:
-**GET /api/1.2/cdns/health.json**
+**GET /api/1.2/cdns/health**
Retrieves the health of all locations (cache groups) for all CDNs.
@@ -318,7 +387,7 @@ Health
|
-**GET /api/1.2/cdns/:name/health.json**
+**GET /api/1.2/cdns/:name/health**
Retrieves the health of all locations (cache groups) for a given CDN.
@@ -378,7 +447,7 @@ Health
|
-**GET /api/1.2/cdns/usage/overview.json**
+**GET /api/1.2/cdns/usage/overview**
Retrieves the high-level CDN usage metrics.
@@ -410,7 +479,7 @@ Health
|
-**GET /api/1.2/cdns/capacity.json**
+**GET /api/1.2/cdns/capacity**
Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.
@@ -450,7 +519,7 @@ Health
Routing
+++++++
-**GET /api/1.2/cdns/routing.json**
+**GET /api/1.2/cdns/routing**
Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.
@@ -496,7 +565,7 @@ Routing
Metrics
+++++++
-**GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end.json**
+**GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end**
Retrieves edge metrics of one or all locations (cache groups).
@@ -585,7 +654,7 @@ Metrics
Domains
+++++++
-**GET /api/1.2/cdns/domains.json**
+**GET /api/1.2/cdns/domains**
Authentication Required: Yes
@@ -635,7 +704,7 @@ Domains
Topology
++++++++
-**GET /api/1.2/cdns/:cdn_name/configs.json**
+**GET /api/1.2/cdns/:cdn_name/configs**
Retrieves CDN config information.
@@ -669,7 +738,7 @@ Topology
|
-**GET /api/1.2/cdns/:name/configs/monitoring.json**
+**GET /api/1.2/cdns/:name/configs/monitoring**
Retrieves CDN monitoring information.
@@ -807,7 +876,7 @@ Topology
|
-**GET /api/1.2/cdns/:name/configs/routing.json**
+**GET /api/1.2/cdns/:name/configs/routing**
Retrieves CDN routing information.
@@ -1025,7 +1094,7 @@ Topology
DNSSEC Keys
+++++++++++
-**GET /api/1.2/cdns/name/:name/dnsseckeys.json**
+**GET /api/1.2/cdns/name/:name/dnsseckeys**
Gets a list of dnsseckeys for a CDN and all associated Delivery Services.
@@ -1122,7 +1191,7 @@ DNSSEC Keys
|
-**GET /api/1.2/cdns/name/:name/dnsseckeys/delete.json**
+**GET /api/1.2/cdns/name/:name/dnsseckeys/delete**
Delete dnssec keys for a cdn and all associated delivery services.
@@ -1211,7 +1280,7 @@ DNSSEC Keys
SSL Keys
+++++++++++
-**GET /api/1.2/cdns/name/:name/sslkeys.json**
+**GET /api/1.2/cdns/name/:name/sslkeys**
Returns ssl certificates for all Delivery Services that are a part of the CDN.
[11/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/server.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/server.html b/docs/latest/development/traffic_ops_api/v11/server.html
index 417b39e..5e6cb9e 100644
--- a/docs/latest/development/traffic_ops_api/v11/server.html
+++ b/docs/latest/development/traffic_ops_api/v11/server.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-server"></span><h1>Server<a class="headerlink" href="#server" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-servers">
<span id="to-api-v11-servers-route"></span><h2>/api/1.1/servers<a class="headerlink" href="#api-1-1-servers" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/servers.json</strong></p>
+<p><strong>GET /api/1.1/servers</strong></p>
<blockquote>
<div><p>Retrieves properties of CDN servers.</p>
<p>Authentication Required: Yes</p>
@@ -198,9 +198,9 @@
<p><strong>Request Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="17%" />
-<col width="15%" />
-<col width="68%" />
+<col width="27%" />
+<col width="13%" />
+<col width="60%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
@@ -213,6 +213,14 @@
<td>no</td>
<td>Used to filter servers by delivery service.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>no</td>
+<td>Used to filter servers by status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>no</td>
+<td>Used to filter servers by type.</td>
+</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
@@ -231,168 +239,467 @@
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><em>Cache Group</em></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
<td>The domain name part of the FQDN of the cache.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
<td>The host name part of the cache.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The server id (database row number).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the lights-out-management port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway address of the lights-out-management port.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the lights-out-management port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
<td>string</td>
<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
<td>string</td>
<td>The user name for lights-out-management.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
<td>string</td>
<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
<td>string</td>
<td>The network interface name used for serving traffic.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
<td>string</td>
<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
<td>string</td>
<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
<td>string</td>
<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time and Date for the last update for this server.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the management port (optional).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway of the management port (optional).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the management port (optional).</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
+<td>The physical location id (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
<td>A string indicating rack location.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
<td>string</td>
<td>The human readable name of the router.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
<td>string</td>
<td>The human readable name of the router port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><em>Status</em></a>).</td>
+<td>The Status id (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
+<td>bool</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">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</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.1/servers/:id</strong></p>
+<blockquote>
+<div><p>Retrieves properties of a CDN server by server ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Server id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</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">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
<td>string</td>
<td>The HTTPS port on which the main application listens (443 in most cases).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
+<td>The server id (database row number).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
<td>string</td>
-<td>Deprecated.</td>
+<td>The IPv4 address of the lights-out-management port.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmppPasswd</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
<td>string</td>
-<td>Deprecated.</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
</tr>
</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">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
- <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
- <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
- <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
- <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
- <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
- <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
- <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-03-08 15:57:32"</span><span class="p">,</span>
- <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
- <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
- <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
- <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
- <span class="s">"xmppId"</span><span class="p">:</span> <span class="s">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
- <span class="s">"xmppPasswd"</span><span class="p">:</span> <span class="s">"**********"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -402,7 +709,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/servers/summary.json</strong></p>
+<p><strong>GET /api/1.1/servers/summary</strong></p>
<blockquote>
<div><p>Retrieves a count of CDN servers by type.</p>
<p>Authentication Required: Yes</p>
@@ -427,41 +734,41 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
+<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- "count": 4,
- "type": "CCR"
- },
- {
- "count": 55,
- "type": "EDGE"
- },
- {
- "type": "MID",
- "count": 18
- },
- {
- "count": 0,
- "type": "INFLUXDB"
- },
- {
- "count": 4,
- "type": "RASCAL"
- }
-}
+<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">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CCR"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">55</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"MID"</span><span class="p">,</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">18</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"INFLUXDB"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"RASCAL"</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.1/servers/hostname/:name/details.json</strong></p>
+<p><strong>GET /api/1.1/servers/hostname/:name/details</strong></p>
<blockquote>
<div><p>Retrieves the details of a server.</p>
<p>Authentication Required: Yes</p>
@@ -502,11 +809,11 @@
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><em>Cache Group</em></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryservices</span></code></td>
<td>array</td>
-<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v11-ds"><em>Delivery Service</em></a>).</td>
+<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v11-ds"><span class="std std-ref">Delivery Service</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
@@ -514,7 +821,7 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">hardwareInfo</span></code></td>
<td>hash</td>
-<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v11-hwinfo"><em>Hardware Info</em></a>).</td>
+<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v11-hwinfo"><span class="std std-ref">Hardware Info</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
@@ -590,11 +897,11 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
@@ -610,7 +917,7 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><em>Status</em></a>).</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
@@ -622,7 +929,7 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td>
<td>string</td>
@@ -635,93 +942,93 @@
</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">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"3"</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="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"4"</span>
<span class="p">],</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s">"YS08"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Model"</span><span class="p">:</span> <span class="s">"PowerEdge R720xd"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s">"4217A5"</span><span class="p">,</span>
- <span class="s">"Lifecycle Controller"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Manufacturer"</span><span class="p">:</span> <span class="s">"Dell Inc."</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"SysMemTotalSize"</span><span class="p">:</span> <span class="s">"196608"</span><span class="p">,</span>
- <span class="s">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s">"24"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s">"13.5.7"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s">"1.00"</span><span class="p">,</span>
- <span class="s">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s">"7.0.0.29"</span><span class="p">,</span>
- <span class="s">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s">"1.57.57"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"ServiceTag"</span><span class="p">:</span> <span class="s">"D6XPDV1"</span><span class="p">,</span>
- <span class="s">"PowerState"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s">"D903"</span><span class="p">,</span>
- <span class="s">"BIOS"</span><span class="p">:</span> <span class="s">"1.3.6"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"System CPLD"</span><span class="p">:</span> <span class="s">"1.0.3"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span>
- <span class="s">"PERC H710P Mini"</span><span class="p">:</span> <span class="s">"21.0.2-0001"</span><span class="p">,</span>
- <span class="s">"PowerCap"</span><span class="p">:</span> <span class="s">"689"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span>
- <span class="s">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s">"1.07"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s">"7.2.20"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s">"D1S2"</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s2">"YS08"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Model"</span><span class="p">:</span> <span class="s2">"PowerEdge R720xd"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s2">"4217A5"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Manufacturer"</span><span class="p">:</span> <span class="s2">"Dell Inc."</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"SysMemTotalSize"</span><span class="p">:</span> <span class="s2">"196608"</span><span class="p">,</span>
+ <span class="s2">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s2">"24"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s2">"13.5.7"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s2">"1.00"</span><span class="p">,</span>
+ <span class="s2">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s2">"7.0.0.29"</span><span class="p">,</span>
+ <span class="s2">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s2">"1.57.57"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"ServiceTag"</span><span class="p">:</span> <span class="s2">"D6XPDV1"</span><span class="p">,</span>
+ <span class="s2">"PowerState"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s2">"D903"</span><span class="p">,</span>
+ <span class="s2">"BIOS"</span><span class="p">:</span> <span class="s2">"1.3.6"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"System CPLD"</span><span class="p">:</span> <span class="s2">"1.0.3"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"PERC H710P Mini"</span><span class="p">:</span> <span class="s2">"21.0.2-0001"</span><span class="p">,</span>
+ <span class="s2">"PowerCap"</span><span class="p">:</span> <span class="s2">"689"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s2">"1.07"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s2">"7.2.20"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s2">"D1S2"</span>
<span class="p">},</span>
- <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
- <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
- <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
- <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
- <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
- <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
- <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
- <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
- <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
- <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
- <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
- <span class="s">"xmppId"</span><span class="p">:</span> <span class="s">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
- <span class="s">"xmppPasswd"</span><span class="p">:</span> <span class="s">"X"</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"xmppId"</span><span class="p">:</span> <span class="s2">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
+ <span class="s2">"xmppPasswd"</span><span class="p">:</span> <span class="s2">"X"</span>
<span class="p">}</span>
<span class="p">}</span>
@@ -769,11 +1076,11 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"host_name"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"servercheck_short_name"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"value"</span><span class="p">:</span> <span class="s">""</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"host_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -815,17 +1122,17 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>Response Example:
-
-{
- "alerts":
- [
- {
- "level": "success",
- "text": "Server Check was successfully updated."
- }
- ],
-}
+<div class="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">"Server Check was successfully updated."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/static_dns.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/static_dns.html b/docs/latest/development/traffic_ops_api/v11/static_dns.html
index 32a65b3..418b03d 100644
--- a/docs/latest/development/traffic_ops_api/v11/static_dns.html
+++ b/docs/latest/development/traffic_ops_api/v11/static_dns.html
@@ -235,18 +235,18 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "deliveryservice": "foo-ds",
- "ttl": "30",
- "type": "CNAME_RECORD",
- "address": "bar.foo.baz.tv.",
- "cachegroup": "us-co-denver",
- "host": "mm"
- }
- ]
-}
+<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">"deliveryservice"</span><span class="p">:</span> <span class="s2">"foo-ds"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CNAME_RECORD"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"bar.foo.baz.tv."</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span><span class="p">,</span>
+ <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"mm"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/status.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/status.html b/docs/latest/development/traffic_ops_api/v11/status.html
index 6d05ea2..bdc5dbf 100644
--- a/docs/latest/development/traffic_ops_api/v11/status.html
+++ b/docs/latest/development/traffic_ops_api/v11/status.html
@@ -190,9 +190,9 @@
<span id="to-api-v11-status"></span><h1>Status<a class="headerlink" href="#status" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-statuses">
<span id="to-api-v11-statuses-route"></span><h2>/api/1.1/statuses<a class="headerlink" href="#api-1-1-statuses" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/statuses.json</strong></p>
+<p><strong>GET /api/1.1/statuses</strong></p>
<blockquote>
-<div><p>Retrieves a list of the server status codes available. May be useful when the status is retrieved from other APIs as a number and not a string.</p>
+<div><p>Retrieves a list of the server status codes available.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
@@ -209,59 +209,130 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>The Time / Date this server entry was last updated</td>
+<td>The id with which Traffic Ops stores this status, and references it internally</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The string equivalent of the status</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>A short description of the status</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</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">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_IGNORE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</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">"name"</span><span class="p">:</span> <span class="s2">"OFFLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</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="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"REPORTED"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/statuses/:id</strong></p>
+<blockquote>
+<div><p>Retrieves a server status by ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Status id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="8%" />
+<col width="76%" />
+</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>The id with which Traffic Ops stores this status, and references it internally</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The string equivalent of the status</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
<td>string</td>
<td>A short description of the status</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
- "id": "4",
- "name": "ADMIN_DOWN",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "CCR_IGNORE",
- "id": "5",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"
- },
- {
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
- "id": "1",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "OFFLINE"
- },
- {
- "id": "2",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "ONLINE"
- },
- {
- "id": "3",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
- "name": "REPORTED",
- "lastUpdated": "2013-02-13 16:34:29"
- }
- ],
-}
+<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">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
[13/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/deliveryservice.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/deliveryservice.html b/docs/latest/development/traffic_ops_api/v11/deliveryservice.html
index e5c86cd..7049ed7 100644
--- a/docs/latest/development/traffic_ops_api/v11/deliveryservice.html
+++ b/docs/latest/development/traffic_ops_api/v11/deliveryservice.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-ds"></span><h1>Delivery Service<a class="headerlink" href="#delivery-service" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-deliveryservices">
<span id="to-api-v11-ds-route"></span><h2>/api/1.1/deliveryservices<a class="headerlink" href="#api-1-1-deliveryservices" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/deliveryservices.json</strong></p>
+<p><strong>GET /api/1.1/deliveryservices</strong></p>
<blockquote>
<div><p>Retrieves all delivery services. See also <a class="reference external" href="http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
@@ -198,82 +198,76 @@
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="10%" />
-<col width="3%" />
-<col width="50%" />
-<col width="38%" />
+<col width="15%" />
+<col width="5%" />
+<col width="80%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
-<th class="head"> </th>
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
-<td>string</td>
-<td>Unique string that describes this deliveryservice.</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">active</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
<td>bool</td>
<td>true if active, false if inactive.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
<td>string</td>
<td>Cache URL rule to apply to this delivery service.</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
-<td>string</td>
-<td><ul class="first last simple">
-<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
-<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
-<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
-</ul>
-</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
-<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
<td>string</td>
<td>The path portion of the URL to check this deliveryservice for health.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS bypass response.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
<td>string</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
<td>string</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
@@ -283,125 +277,139 @@ globalMaxMbps traffic on this deliveryservice.</td>
<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
routing to the content by Traffic Router.</p>
</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
<td>string</td>
<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
-<td> </td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">headerRewrite</span></code></td>
-<td>string</td>
-<td>The EDGE header rewrite actions to perform.</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
<td>string</td>
<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The deliveryservice id (database row number).</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
<td>string</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
<td>bool</td>
<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
<td>Description field 2.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
<td>string</td>
<td>Description field 2.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
<td>array</td>
<td>Array of matchList hashes.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
<td>string</td>
<td>The set Number of the matchList.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
<td>string</td>
<td>The regexp for the matchList.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
<td>string</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
-<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
<td>string</td>
<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
<td>string</td>
<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
-<td>string</td>
-<td>The MID header rewrite actions to perform.</td>
-<td> </td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
-<td>string</td>
-<td> </td>
-<td>Is the Multi Site Origin feature enabled for this delivery service. See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
<td>The origin server base URL (FQDN when used in this instance, includes the
protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
<td>string</td>
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
-<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
<td>string</td>
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
<td>string</td>
<td><ul class="first last simple">
<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
@@ -409,109 +417,142 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<li>2: drop query string at edge, and do not use it in the cache-key.</li>
</ul>
</td>
-<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
<td>string</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
<td>string</td>
<td>Additional raw remap line text.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
<td>bool</td>
<td><ul class="first last simple">
<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
<li>true: token based auth is enabled for this deliveryservice.</li>
</ul>
</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
<td>string</td>
-<td><p class="first">How to treat range requests:</p>
-<ul class="last simple">
-<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
-<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
-<li>2 Use the cache_range_requests plugin.</li>
-</ul>
-</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
-<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
<td>string</td>
-<td>Entry points into the CDN for this deliveryservice.</td>
<td> </td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
- },
- { .. },
- { .. }
- ],
-}
+<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">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="o">..</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.1/deliveryservices/:id.json</strong></p>
+<p><strong>GET /api/1.1/deliveryservices/:id</strong></p>
<blockquote>
<div><p>Retrieves a specific delivery service. See also <a class="reference external" href="http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
@@ -530,58 +571,65 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
-<td>string</td>
-<td>Unique string that describes this deliveryservice.</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">active</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
<td>bool</td>
<td>true if active, false if inactive.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
<td>string</td>
<td>Cache URL rule to apply to this delivery service.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
-<td>string</td>
-<td><ul class="first last simple">
-<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
-<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
-<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
-</ul>
-</td>
-</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
<td>string</td>
<td>The path portion of the URL to check this deliveryservice for health.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS bypass response.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
<td>string</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
<td>string</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
@@ -592,21 +640,25 @@ globalMaxMbps traffic on this deliveryservice.</td>
routing to the content by Traffic Router.</p>
</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
<td>string</td>
<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">headerRewrite</span></code></td>
-<td>string</td>
-<td>The EDGE header rewrite actions to perform.</td>
-</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
<td>string</td>
<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
@@ -620,43 +672,59 @@ globalMaxMbps traffic on this deliveryservice.</td>
<td>string</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
<td>bool</td>
<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
<td>Description field 2.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
<td>string</td>
<td>Description field 2.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
<td>array</td>
<td>Array of matchList hashes.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
<td>string</td>
<td>The set Number of the matchList.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
<td>string</td>
<td>The regexp for the matchList.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
<td>string</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
<td>string</td>
<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
@@ -665,23 +733,44 @@ available).</td>
<td>string</td>
<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
-<td>string</td>
-<td>The MID header rewrite actions to perform.</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
<td>The origin server base URL (FQDN when used in this instance, includes the
protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
<td>string</td>
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
<td>string</td>
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
<td>string</td>
<td><ul class="first last simple">
@@ -691,10 +780,24 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</ul>
</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
<td>string</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
<td>string</td>
<td>Additional raw remap line text.</td>
@@ -707,75 +810,101 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</ul>
</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
<td>string</td>
-<td><p class="first">How to treat range requests:</p>
-<ul class="last simple">
-<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
-<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
-<li>2 Use the cache_range_requests plugin.</li>
-</ul>
-</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
<td>string</td>
-<td>Entry points in to the CDN for this deliveryservice.</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
</tr>
</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">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"protocol"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"ccrDnsTtl"</span><span class="p">:</span> <span class="s">"3600"</span><span class="p">,</span>
- <span class="s">"checkPath"</span><span class="p">:</span> <span class="s">"/crossdomain.xml"</span><span class="p">,</span>
- <span class="s">"dnsBypassIp"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"dnsBypassIp6"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"dnsBypassTtl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"dscp"</span><span class="p">:</span> <span class="s">"40"</span><span class="p">,</span>
- <span class="s">"geoLimit"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"globalMaxMbps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"globalMaxTps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"headerRewrite"</span><span class="p">:</span> <span class="s">"add-header X-Powered-By: KABLETOWN [L]"</span><span class="p">,</span>
- <span class="s">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="s">"add-header X-Powered-By: KABLETOWN [L]"</span><span class="p">,</span>
- <span class="s">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"httpBypassFqdn"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"rangeRequestHandling"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"12"</span><span class="p">,</span>
- <span class="s">"infoUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"longDesc"</span><span class="p">:</span> <span class="s">"long_desc"</span><span class="p">,</span>
- <span class="s">"longDesc1"</span><span class="p">:</span> <span class="s">"long_desc_1"</span><span class="p">,</span>
- <span class="s">"longDesc2"</span><span class="p">:</span> <span class="s">"long_desc_2"</span><span class="p">,</span>
- <span class="s">"matchList"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HOST_REGEXP"</span><span class="p">,</span>
- <span class="s">"setNumber"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">.images</span><span class="se">\\</span><span class="s">..*"</span>
- <span class="p">}</span>
- <span class="p">],</span>
- <span class="s">"maxDnsAnswers"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"missLat"</span><span class="p">:</span> <span class="s">"41.881944"</span><span class="p">,</span>
- <span class="s">"missLong"</span><span class="p">:</span> <span class="s">"-87.627778"</span><span class="p">,</span>
- <span class="s">"orgServerFqdn"</span><span class="p">:</span> <span class="s">"http://cdl.origin.kabletown.net"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for cdn2.comcast.net"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"EDGE_CDN2"</span><span class="p">,</span>
- <span class="s">"qstringIgnore"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"signed"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HTTP"</span><span class="p">,</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"cdl-c2"</span><span class="p">,</span>
- <span class="s">"exampleURLs"</span><span class="p">:</span> <span class="p">[]</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -832,15 +961,15 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</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">"failover"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
- <span class="s">"destination"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"enabled"</span><span class="p">:</span> <span class="n">false</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">"failover"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
+ <span class="s2">"destination"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">},</span>
- <span class="s">"enabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -896,20 +1025,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -982,12 +1111,12 @@ delivery service that is down for maintenance.</td>
</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1063,14 +1192,14 @@ client to the overflow CDN.</td>
</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1225,22 +1354,22 @@ client to the overflow CDN.</td>
</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">"stats"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"count"</span><span class="p">:</span> <span class="mi">988</span><span class="p">,</span>
- <span class="s">"98thPercentile"</span><span class="p">:</span> <span class="mf">16589105.55958</span><span class="p">,</span>
- <span class="s">"min"</span><span class="p">:</span> <span class="mf">3185442.975</span><span class="p">,</span>
- <span class="s">"max"</span><span class="p">:</span> <span class="mf">17124754.257</span><span class="p">,</span>
- <span class="s">"5thPercentile"</span><span class="p">:</span> <span class="mf">3901253.95445</span><span class="p">,</span>
- <span class="s">"95thPercentile"</span><span class="p">:</span> <span class="mf">16013210.034</span><span class="p">,</span>
- <span class="s">"median"</span><span class="p">:</span> <span class="mf">8816895.576</span><span class="p">,</span>
- <span class="s">"mean"</span><span class="p">:</span> <span class="mf">8995846.31741194</span><span class="p">,</span>
- <span class="s">"stddev"</span><span class="p">:</span> <span class="mf">3941169.83683573</span><span class="p">,</span>
- <span class="s">"sum"</span><span class="p">:</span> <span class="mf">333296106.060112</span>
+ <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">988</span><span class="p">,</span>
+ <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">16589105.55958</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mf">3185442.975</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">17124754.257</span><span class="p">,</span>
+ <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">3901253.95445</span><span class="p">,</span>
+ <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">16013210.034</span><span class="p">,</span>
+ <span class="s2">"median"</span><span class="p">:</span> <span class="mf">8816895.576</span><span class="p">,</span>
+ <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">8995846.31741194</span><span class="p">,</span>
+ <span class="s2">"stddev"</span><span class="p">:</span> <span class="mf">3941169.83683573</span><span class="p">,</span>
+ <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">333296106.060112</span>
<span class="p">},</span>
- <span class="s">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
<span class="mi">1414303200000</span><span class="p">,</span>
<span class="mf">12923518.466</span>
@@ -1250,7 +1379,7 @@ client to the overflow CDN.</td>
<span class="mf">12625139.65</span>
<span class="p">]</span>
<span class="p">],</span>
- <span class="s">"label"</span><span class="p">:</span> <span class="s">"MID Kbps"</span>
+ <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"MID Kbps"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1317,22 +1446,22 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
- <span class="s">"orderby"</span><span class="p">:</span> <span class="s">"deliveryservice"</span><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">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"orderby"</span><span class="p">:</span> <span class="s2">"deliveryservice"</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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:43"</span><span class="p">,</span>
- <span class="s">"server"</span><span class="p">:</span> <span class="s">"20"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:43"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"20"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:44"</span><span class="p">,</span>
- <span class="s">"server"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:44"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">},</span>
<span class="p">],</span>
- <span class="s">"limit"</span><span class="p">:</span> <span class="mi">2</span>
+ <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">2</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1444,20 +1573,20 @@ client to the overflow CDN.</td>
</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
<span class="p">},</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1567,20 +1696,20 @@ client to the overflow CDN.</td>
</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
<span class="p">},</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1654,8 +1783,8 @@ client to the overflow CDN.</td>
</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="s">"Successfully deleted ssl keys for <xml_id>"</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="s2">"Successfully deleted ssl keys for <xml_id>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1717,20 +1846,20 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"ds-01"</span><span class="p">,</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN Engineering"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
- <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"some_key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"some_csr"</span><span class="p">,</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"some_crt"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN Engineering"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span clas
<TRUNCATED>
[18/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/quick_howto/multi_site.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/multi_site.html b/docs/latest/admin/quick_howto/multi_site.html
index 2802e65..ffc8ea1 100644
--- a/docs/latest/admin/quick_howto/multi_site.html
+++ b/docs/latest/admin/quick_howto/multi_site.html
@@ -191,23 +191,23 @@
<ol class="arabic simple">
<li>Create “cachegroups” for the origin locations, and assign the appropriate parent-child relationship between the mid cg’s and org cgs (click the image to see full size):</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png"><img alt="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" class="align-center" src="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" /></a>
+<a class="reference internal image-reference" href="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png"><img alt="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" class="align-center" src="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" style="width: 1472.0px; height: 210.0px;" /></a>
<ol class="arabic simple" start="2">
<li>Create a profile to assign to each of the origins:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png"><img alt="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" class="align-center" src="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" /></a>
+<a class="reference internal image-reference" href="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png"><img alt="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" class="align-center" src="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" style="width: 1470.0px; height: 219.0px;" /></a>
<ol class="arabic simple" start="3">
<li>Create server entries for the origination vips:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png"><img alt="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" class="align-center" src="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" /></a>
+<a class="reference internal image-reference" href="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png"><img alt="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" class="align-center" src="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" style="width: 1468.0px; height: 166.0px;" /></a>
<ol class="arabic simple" start="4">
<li>Check the multi-site check box in the delivery service screen and make sure that Content Routing Type is set to HTTP_LIVE_NATL:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/mso-enable.png"><img alt="../../_images/mso-enable.png" class="align-center" src="../../_images/mso-enable.png" /></a>
+<a class="reference internal image-reference" href="../../_images/mso-enable.png"><img alt="../../_images/mso-enable.png" class="align-center" src="../../_images/mso-enable.png" style="width: 1695.0px; height: 1079.0px;" /></a>
<ol class="arabic simple" start="5">
<li>Assign the org servers to the delivery service that will have the multi site feature:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png"><img alt="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" class="align-center" src="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" /></a>
+<a class="reference internal image-reference" href="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png"><img alt="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" class="align-center" src="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" style="width: 580.0px; height: 343.0px;" /></a>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">\u201cOrigin Server Base URL\u201d uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that \u201cOrigin Server Base URL\u201d (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The exceptions are:
@@ -234,7 +234,11 @@
</tr>
<tr class="row-odd"><td>Primary/back</td>
<td>Round robin selection does not occur. The first origin server is selected unless it fails.
-If the first fails, the second and other following origin servers will be tried by order.</td>
+If the first fails, the second and other following origin servers will be tried by order.
+Order is defined by 2 factors - if the origin server’s cachegroup is configured as the
+parent cachegroup for the mid, then this server will be used as the primary. The same rules
+apply for secondary parents, in order. Within the cachegroups, the rank parameter will sort
+order further. If no parents are defined at the mid, then only rank is considered.</td>
</tr>
<tr class="row-even"><td>Strict
round-robin</td>
@@ -248,16 +252,16 @@ round-robin</td>
</tbody>
</table>
<ol class="arabic simple" start="7">
-<li>Optionally, if “Primary/backup” is selected for “Multi Site Origin Algorithm”, a new parameter \u201crank\u201d should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of “2” precedes OS with the rank of “5”. For any OS, if rank value is not defined in its profile, its rank value will default to \u201c1\u201d.</li>
+<li>Optionally, there are two configuration options that can set the order of the origins used if “Primary/backup” is selected for “Multi Site Origin Algorithm”. By creating location-based cachegroups and assigning the origin servers accordingly and defining these cachegroups as parents for specific mids, location-based primary/secondary selection can be made. If primary/secondary selection should be the same for all mids, then a new parameter \u201crank\u201d should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of “2” precedes OS with the rank of “5”. For any OS, if rank value is not defined in its profile, its rank value will default to \u201c1\u201d. In the event that both location based cachegroups are used alongside rank, sorting will be by cachegroup first and rank second. In this way it is possible to have specific bac
kup servers for use at specific locations.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/mso-rank.png"><img alt="../../_images/mso-rank.png" class="align-center" src="../../_images/mso-rank.png" /></a>
+<a class="reference internal image-reference" href="../../_images/mso-rank.png"><img alt="../../_images/mso-rank.png" class="align-center" src="../../_images/mso-rank.png" style="width: 585.0px; height: 105.6px;" /></a>
<ol class="arabic simple" start="8">
<li>Assign the parent.config location parameter to the MID profile:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png"><img alt="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" class="align-center" src="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" /></a>
+<a class="reference internal image-reference" href="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png"><img alt="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" class="align-center" src="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" style="width: 658.0px; height: 601.0px;" /></a>
<ol class="arabic" start="9">
<li><p class="first">Configure the mid hdr_rewrite on the delivery service, example:</p>
-<div class="highlight-python"><div class="highlight"><pre>cond %{REMAP_PSEUDO_HOOK} __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_response_codes "400,404,412" __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_response_codes "502,503" __RETURN__ set-config proxy.config.http.connect_attempts_timeout 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries_dead_server 1 __RETURN__ set-config proxy.config.http.transaction_active_timeout_in 5 [L] __RETURN__
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cond</span> <span class="o">%</span><span class="p">{</span><span class="n">REMAP_PSEUDO_HOOK</span><span class="p">}</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_enabled</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_enabled</span> <sp
an class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_response_codes</span> <span class="s2">"400,404,412"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_response_codes</span> <span class="s2">"502,503"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span
> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_timeout</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries_dead_server</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set<
/span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">transaction_active_timeout_in</span> <span class="mi">5</span> <span class="p">[</span><span class="n">L</span><span class="p">]</span> <span class="n">__RETURN__</span>
</pre></div>
</div>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/quick_howto/regionalgeo.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/regionalgeo.html b/docs/latest/admin/quick_howto/regionalgeo.html
index 97f9b0d..f753af0 100644
--- a/docs/latest/admin/quick_howto/regionalgeo.html
+++ b/docs/latest/admin/quick_howto/regionalgeo.html
@@ -196,24 +196,24 @@
<li>Prepare RGB configuration file</li>
</ol>
<p>RGB uses a configuration file in JSON format to define regional geo-blocking rules for delivery services. The file needs to be put on an HTTP server accessible to Traffic Router. An example of the JSON is as follows:</p>
-<div class="highlight-python"><div class="highlight"><pre>{
-"deliveryServices":
- [
- {
- "deliveryServiceId": "hls-live",
- "urlRegex": ".*live4\\.m3u8",
- "geoLocation": {"includePostalCode":["N0H", "L9V", "L9W"]},
- "redirectUrl": "http://third-party.com/blacked_out.html"
- },
- {
- "deliveryServiceId": "hls-live",
- "urlRegex": ".*live5\\.m3u8",
- "ipWhiteList": [185.68.71.9/22","142.232.0.79/24"],
- "geoLocation": {"excludePostalCode":["N0H", "L9V"]},
- "redirectUrl": "/live5_low_bitrate.m3u8"
- }
- ]
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+<span class="s2">"deliveryServices"</span><span class="p">:</span>
+ <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="s2">"hls-live"</span><span class="p">,</span>
+ <span class="s2">"urlRegex"</span><span class="p">:</span> <span class="s2">".*live4</span><span class="se">\\</span><span class="s2">.m3u8"</span><span class="p">,</span>
+ <span class="s2">"geoLocation"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"includePostalCode"</span><span class="p">:[</span><span class="s2">"N0H"</span><span class="p">,</span> <span class="s2">"L9V"</span><span class="p">,</span> <span class="s2">"L9W"</span><span class="p">]},</span>
+ <span class="s2">"redirectUrl"</span><span class="p">:</span> <span class="s2">"http://third-party.com/blacked_out.html"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="s2">"hls-live"</span><span class="p">,</span>
+ <span class="s2">"urlRegex"</span><span class="p">:</span> <span class="s2">".*live5</span><span class="se">\\</span><span class="s2">.m3u8"</span><span class="p">,</span>
+ <span class="s2">"ipWhiteList"</span><span class="p">:</span> <span class="p">[</span><span class="mf">185.68</span><span class="o">.</span><span class="mf">71.9</span><span class="o">/</span><span class="mi">22</span><span class="s2">","</span><span class="mf">142.232</span><span class="o">.</span><span class="mf">0.79</span><span class="o">/</span><span class="mi">24</span><span class="s2">"],</span>
+ <span class="s2">"geoLocation"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"excludePostalCode"</span><span class="p">:[</span><span class="s2">"N0H"</span><span class="p">,</span> <span class="s2">"L9V"</span><span class="p">]},</span>
+ <span class="s2">"redirectUrl"</span><span class="p">:</span> <span class="s2">"/live5_low_bitrate.m3u8"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
<ul class="simple">
@@ -231,23 +231,23 @@
<li>“regional_geoblocking.polling.url”: the HTTP URL of RGB configuration file. Traffic Router will fetch the file from this URL.</li>
<li>“regional_geoblocking.polling.interval”: the interval that Traffic Router polls the RGB configuration file.</li>
</ul>
-<a class="reference internal image-reference" href="../../_images/regionalgeo01.png"><img alt="../../_images/regionalgeo01.png" class="align-center" src="../../_images/regionalgeo01.png" /></a>
+<a class="reference internal image-reference" href="../../_images/regionalgeo01.png"><img alt="../../_images/regionalgeo01.png" class="align-center" src="../../_images/regionalgeo01.png" style="width: 1234.0px; height: 430.0px;" /></a>
<ol class="arabic simple" start="3">
<li>Enable RGB for a delivery service</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/regionalgeo02.png"><img alt="../../_images/regionalgeo02.png" class="align-center" src="../../_images/regionalgeo02.png" /></a>
+<a class="reference internal image-reference" href="../../_images/regionalgeo02.png"><img alt="../../_images/regionalgeo02.png" class="align-center" src="../../_images/regionalgeo02.png" style="width: 1046.0px; height: 1054.0px;" /></a>
<ol class="arabic simple" start="4">
<li>Make configuration effective</li>
</ol>
<p>Go to Tools->Snapshot CRConfig, perform \u201cDiff CRConfig\u201d and click “Write CRConfig”.</p>
-<a class="reference internal image-reference" href="../../_images/regionalgeo03.png"><img alt="../../_images/regionalgeo03.png" class="align-center" src="../../_images/regionalgeo03.png" /></a>
+<a class="reference internal image-reference" href="../../_images/regionalgeo03.png"><img alt="../../_images/regionalgeo03.png" class="align-center" src="../../_images/regionalgeo03.png" style="width: 464.8px; height: 128.8px;" /></a>
<ol class="arabic simple" start="5">
<li>Traffic Router access log with RGB</li>
</ol>
<p>RGB extends the field of “rtype” and adds a new field “rgb” in Traffic Router access.log to help to monitor the working of this feature.</p>
<p>For “rtype”, RGALT indicates that a request is redirected to an alternate URL by RGB; RGDENY indicates that a request is denied by RGB because there is no matching rule in JSON for this request.</p>
<p>For “rgb”, when RGB is enabled, it will be non-empty with following format:</p>
-<div class="highlight-python"><div class="highlight"><pre>{FSA}:{allowed/disallowed}:{include/exclude postal}:{fallback config/current config}:{allowed by whitelist/otherwise}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span><span class="n">FSA</span><span class="p">}:{</span><span class="n">allowed</span><span class="o">/</span><span class="n">disallowed</span><span class="p">}:{</span><span class="n">include</span><span class="o">/</span><span class="n">exclude</span> <span class="n">postal</span><span class="p">}:{</span><span class="n">fallback</span> <span class="n">config</span><span class="o">/</span><span class="n">current</span> <span class="n">config</span><span class="p">}:{</span><span class="n">allowed</span> <span class="n">by</span> <span class="n">whitelist</span><span class="o">/</span><span class="n">otherwise</span><span class="p">}</span>
</pre></div>
</div>
<ul class="simple">
@@ -258,11 +258,11 @@
<li>{allowed by whitelist/otherwise}: If a request is allowed by whitelist, this flag is set to 1; for all other cases, it is 0.</li>
</ul>
<p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>1446442214.685 qtype=HTTP chi=129.100.254.79 url="http://ccr.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="-" rdtl=- rerr="-" rgb="N6G:1:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/live5.m3u8 rh="-"
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1446442214.685</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">129.100</span><span class="o">.</span><span class="mf">254.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live5.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span
class="o">=</span><span class="s2">"N6G:1:X:0:0"</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">live5</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
-1446442219.181 qtype=HTTP chi=184.68.71.9 url="http://ccr.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGALT rloc="-" rdtl=- rerr="-" rgb="-:0:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/low_bitrate.m3u8 rh="-"
+<span class="mf">1446442219.181</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">184.68</span><span class="o">.</span><span class="mf">71.9</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live5.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">RGALT</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"-:0:X:0:0"</span> <span cl
ass="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">low_bitrate</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
-1446445521.677 qtype=HTTP chi=24.114.29.79 url="http://ccr.geo2.cdn.com/live51.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGDENY rloc="-" rdtl=- rerr="-" rgb="L4S:0:-:0:0" pssc=520 ttms=3 rurl="-" rh="-"
+<span class="mf">1446445521.677</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">24.114</span><span class="o">.</span><span class="mf">29.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live51.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">RGDENY</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"L4S:0:-:0:0"</span> <sp
an class="n">pssc</span><span class="o">=</span><span class="mi">520</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
</pre></div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/quick_howto/steering.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/steering.html b/docs/latest/admin/quick_howto/steering.html
index 839b30b..918c8a3 100644
--- a/docs/latest/admin/quick_howto/steering.html
+++ b/docs/latest/admin/quick_howto/steering.html
@@ -191,19 +191,19 @@
<ol class="arabic simple">
<li>Create two target delivery services in Traffic Ops. They must both be HTTP delivery services that are part of the same CDN.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering01.png"><img alt="../../_images/steering01.png" class="align-center" src="../../_images/steering01.png" /></a>
+<a class="reference internal image-reference" href="../../_images/steering01.png"><img alt="../../_images/steering01.png" class="align-center" src="../../_images/steering01.png" style="width: 1172.0px; height: 232.0px;" /></a>
<ol class="arabic simple" start="2">
<li>Create a delivery service with type STEERING in Traffic Ops.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering02.png"><img alt="../../_images/steering02.png" class="align-center" src="../../_images/steering02.png" /></a>
+<a class="reference internal image-reference" href="../../_images/steering02.png"><img alt="../../_images/steering02.png" class="align-center" src="../../_images/steering02.png" style="width: 811.0px; height: 617.0px;" /></a>
<ol class="arabic simple" start="3">
<li>Click the ‘Manage Steering Assignments’ button on the delivery service screen to assign targets.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering03.png"><img alt="../../_images/steering03.png" class="align-center" src="../../_images/steering03.png" /></a>
+<a class="reference internal image-reference" href="../../_images/steering03.png"><img alt="../../_images/steering03.png" class="align-center" src="../../_images/steering03.png" style="width: 757.0px; height: 598.0px;" /></a>
<ol class="arabic simple" start="4">
<li>Create a user with the role of Steering.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering04.png"><img alt="../../_images/steering04.png" class="align-center" src="../../_images/steering04.png" /></a>
+<a class="reference internal image-reference" href="../../_images/steering04.png"><img alt="../../_images/steering04.png" class="align-center" src="../../_images/steering04.png" style="width: 650.0px; height: 487.0px;" /></a>
<ol class="arabic" start="5">
<li><p class="first">As the steering user, assign weights to target delivery services. This will require logging in to Traffic Ops first via <code class="docutils literal"><span class="pre">http://to.kabletown.net/api/1.2/user/login</span></code> and storing the mojolicious cookie.</p>
<blockquote>
@@ -212,15 +212,15 @@
</div></blockquote>
</li>
</ol>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"targets"</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">"targets"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"weight"</span><span class="p">:</span> <span class="s">"1000"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-1"</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"1000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"weight"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-2"</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-2"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -234,21 +234,21 @@
</div></blockquote>
</li>
</ol>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"filters"</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">"filters"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">gototarget1</span><span class="se">\\</span><span class="s">..*"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-1"</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">gototarget1</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s">"targets"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"targets"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"weight"</span><span class="p">:</span> <span class="s">"1000"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-1"</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"1000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"weight"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-2"</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-2"</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/admin/traffic_monitor.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_monitor.html b/docs/latest/admin/traffic_monitor.html
index b5ba3d8..75e7310 100644
--- a/docs/latest/admin/traffic_monitor.html
+++ b/docs/latest/admin/traffic_monitor.html
@@ -107,7 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Monitor Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
@@ -210,7 +210,7 @@
<li><p class="first">Take the config from Traffic Ops - run : <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">/opt/traffic_monitor/bin/traffic_monitor_config.pl</span></code></p>
<blockquote>
<div><p>Sample output:</p>
-<div class="highlight-python"><div class="highlight"><pre>traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt
+<div class="highlight-default"><div class="highlight"><pre><span></span>traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt
DEBUG: traffic_ops selected: https://traffic-ops.cdn.kabletown.net
DEBUG: traffic_ops login: admin:kl0tevax
DEBUG: Config write mode: prompt
@@ -293,13 +293,13 @@ traffic_mon #
</div></blockquote>
</li>
<li><p class="first">Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code></p>
-<div class="highlight-python"><div class="highlight"><pre>Using CATALINA_BASE: /opt/tomcat
-Using CATALINA_HOME: /opt/tomcat
-Using CATALINA_TMPDIR: /opt/tomcat/temp
-Using JRE_HOME: /usr
-Using CLASSPATH:/opt/tomcat/bin/bootstrap.jar
-Using CATALINA_PID:/var/run/tomcat/tomcat.pid
-Starting tomcat [ OK ]
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Using</span> <span class="n">CATALINA_BASE</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span>
+<span class="n">Using</span> <span class="n">CATALINA_HOME</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span>
+<span class="n">Using</span> <span class="n">CATALINA_TMPDIR</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="n">temp</span>
+<span class="n">Using</span> <span class="n">JRE_HOME</span><span class="p">:</span> <span class="o">/</span><span class="n">usr</span>
+<span class="n">Using</span> <span class="n">CLASSPATH</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">bootstrap</span><span class="o">.</span><span class="n">jar</span>
+<span class="n">Using</span> <span class="n">CATALINA_PID</span><span class="p">:</span><span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="n">tomcat</span><span class="o">.</span><span class="n">pid</span>
+<span class="n">Starting</span> <span class="n">tomcat</span> <span class="p">[</span> <span class="n">OK</span> <span class="p">]</span>
</pre></div>
</div>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/traffic_ops_config.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_ops_config.html b/docs/latest/admin/traffic_ops_config.html
index 06ce343..da47adf 100644
--- a/docs/latest/admin/traffic_ops_config.html
+++ b/docs/latest/admin/traffic_ops_config.html
@@ -103,7 +103,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Configuring Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
@@ -315,7 +315,7 @@ The Traffic Monitor IP addresses have to be included in this, if they are using
</tr>
<tr class="row-even"><td>purge_allow_ip</td>
<td>ip_allow.config</td>
-<td>The IP address range that is allowed to execute the PURGE method on the caches (not related to <a class="reference internal" href="traffic_ops_using.html#rl-purge"><em>Invalidate Content</em></a>)</td>
+<td>The IP address range that is allowed to execute the PURGE method on the caches (not related to <a class="reference internal" href="traffic_ops_using.html#rl-purge"><span class="std std-ref">Invalidate Content</span></a>)</td>
</tr>
<tr class="row-odd"><td>health.threshold.loadavg</td>
<td>rascal.properties</td>
@@ -377,7 +377,7 @@ Value is left blank.</td>
</div>
<div class="section" id="configuring-content-purge">
<h2>Configuring Content Purge<a class="headerlink" href="#configuring-content-purge" title="Permalink to this headline">�</a></h2>
-<p>Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html">Regex Revalidate Plugin</a> to purge content from the system. We don’t actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it’s config file, and will pick up changes to it without a <cite>traffic_line -x</cite> signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the low
er tiers with the content that should be purged from the higher tiers without hitting the origin. This is why the ort script (see <a class="reference internal" href="traffic_server.html#reference-traffic-ops-ort"><em>Configuring Traffic Server</em></a>) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the <cite>regex_revalidate.config</cite> file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the <cite>regex_revalidate.config</cite> file.</p>
+<p>Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html">Regex Revalidate Plugin</a> to purge content from the system. We don’t actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it’s config file, and will pick up changes to it without a <cite>traffic_line -x</cite> signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the low
er tiers with the content that should be purged from the higher tiers without hitting the origin. This is why the ort script (see <a class="reference internal" href="traffic_server.html#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a>) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the <cite>regex_revalidate.config</cite> file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the <cite>regex_revalidate.config</cite> file.</p>
<p>Content Purge is controlled by the following parameters in the profile of the cache:</p>
<table border="1" class="docutils">
<colgroup>
@@ -424,13 +424,13 @@ For example: –config regex_revalidate.config</td>
<li>Start the kickstart installation.</li>
</ol>
<p>Create a ks.src file in the root of the selection location. See the example below:</p>
-<div class="highlight-python"><div class="highlight"><pre>mkdir newdir
-cd newdir/
-cp -r ../centos65/* .
-vim ks.src
-vim isolinux/isolinux.cfg
-cd vim osversions.cfg
-vim osversions.cfg
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">newdir</span>
+<span class="n">cd</span> <span class="n">newdir</span><span class="o">/</span>
+<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="o">../</span><span class="n">centos65</span><span class="o">/*</span> <span class="o">.</span>
+<span class="n">vim</span> <span class="n">ks</span><span class="o">.</span><span class="n">src</span>
+<span class="n">vim</span> <span class="n">isolinux</span><span class="o">/</span><span class="n">isolinux</span><span class="o">.</span><span class="n">cfg</span>
+<span class="n">cd</span> <span class="n">vim</span> <span class="n">osversions</span><span class="o">.</span><span class="n">cfg</span>
+<span class="n">vim</span> <span class="n">osversions</span><span class="o">.</span><span class="n">cfg</span>
</pre></div>
</div>
<p>This is a standard kickstart formatted file that the generate ISO process uses to create the kickstart (ks.cfg) file for the install. The generate ISO process uses the ks.src, overwriting any information set in the Generate ISO tab in Traffic Ops, creating ks.cfg.</p>
[34/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/cdn.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/cdn.html b/docs/1.7.0/development/traffic_ops_api/v12/cdn.html
index 3802620..f1ab42c 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/cdn.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/cdn.html
@@ -190,16 +190,16 @@
<span id="to-api-v12-cdn"></span><h1>CDN<a class="headerlink" href="#cdn" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-cdns">
<span id="to-api-v12-cdn-route"></span><h2>/api/1.2/cdns<a class="headerlink" href="#api-1-2-cdns" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns.json</strong></p>
+<p><strong>GET /api/1.2/cdns</strong></p>
<blockquote>
<div><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="24%" />
+<col width="25%" />
<col width="11%" />
-<col width="65%" />
+<col width="64%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -208,22 +208,38 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>CDN name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>int</td>
-<td>CDN id.</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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-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">"name"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="mi">1</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">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">true</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>
@@ -233,16 +249,36 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/name/:name.json</strong></p>
+<p><strong>GET /api/1.2/cdns/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>CDN id.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="24%" />
+<col width="25%" />
<col width="11%" />
-<col width="65%" />
+<col width="64%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -251,22 +287,105 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>CDN name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>int</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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">"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">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/name/:name</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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>CDN name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</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>CDN id.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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-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">"name"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="mi">1</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">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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>
@@ -308,9 +427,9 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"cdn_test"</span><span class="p">,</span>
- <span class="s">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+<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">"cdn_test"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -359,19 +478,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response":{
- "name": "cdn_test",
- "id": 3
- "dnssecEnabled": 0
- },
- "alerts":[
- {
- "level": "success",
- "text": "cdn was created."
- }
- ]
-}
+<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="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">3</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</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">"cdn was created."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -430,9 +549,9 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"cdn_test2"</span><span class="p">,</span>
- <span class="s">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+<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">"cdn_test2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -481,19 +600,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response":{
- "name": "cdn_test2",
- "id": 3
- "dnssecEnabled": 0
- },
- "alerts":[
- {
- "level": "success",
- "text": "cdn was updated."
- }
- ]
-}
+<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="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test2"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">3</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</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">"cdn was updated."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -554,11 +673,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"cdn was deleted."</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">"cdn was deleted."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -571,7 +690,7 @@
</div>
<div class="section" id="health">
<h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">�</a></h2>
-<p id="to-api-v12-cdn-health-route"><strong>GET /api/1.2/cdns/health.json</strong></p>
+<p id="to-api-v12-cdn-health-route"><strong>GET /api/1.2/cdns/health</strong></p>
<blockquote>
<div><p>Retrieves the health of all locations (cache groups) for all CDNs.</p>
<p>Authentication Required: Yes</p>
@@ -618,20 +737,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -642,7 +761,7 @@ group.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/:name/health.json</strong></p>
+<p><strong>GET /api/1.2/cdns/:name/health</strong></p>
<blockquote>
<div><p>Retrieves the health of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -711,20 +830,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -735,7 +854,7 @@ group.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/usage/overview.json</strong></p>
+<p><strong>GET /api/1.2/cdns/usage/overview</strong></p>
<blockquote>
<div><p>Retrieves the high-level CDN usage metrics.</p>
<p>Authentication Required: Yes</p>
@@ -769,11 +888,11 @@ group.</td>
</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">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
- <span class="s">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
- <span class="s">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</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">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
+ <span class="s2">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
+ <span class="s2">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -782,7 +901,7 @@ group.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/capacity.json</strong></p>
+<p><strong>GET /api/1.2/cdns/capacity</strong></p>
<blockquote>
<div><p>Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -820,12 +939,12 @@ group.</td>
</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -837,7 +956,7 @@ group.</td>
</div>
<div class="section" id="routing">
<span id="to-api-v12-cdn-routing"></span><h2>Routing<a class="headerlink" href="#routing" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/routing.json</strong></p>
+<p><strong>GET /api/1.2/cdns/routing</strong></p>
<blockquote>
<div><p>Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -883,14 +1002,14 @@ group.</td>
</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -902,7 +1021,7 @@ group.</td>
</div>
<div class="section" id="metrics">
<span id="to-api-v12-cdn-metrics"></span><h2>Metrics<a class="headerlink" href="#metrics" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end.json</strong></p>
+<p><strong>GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end</strong></p>
<blockquote>
<div><p>Retrieves edge metrics of one or all locations (cache groups).</p>
<p>Authentication Required: Yes</p>
@@ -1004,20 +1123,20 @@ group.</td>
</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">"stats"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
- <span class="s">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
+ <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
<span class="p">},</span>
- <span class="s">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
<span class="mi">1425135900000</span><span class="p">,</span>
<span class="mf">1668.03</span>
@@ -1027,7 +1146,7 @@ group.</td>
<span class="n">null</span>
<span class="p">]</span>
<span class="p">],</span>
- <span class="s">"label"</span><span class="p">:</span> <span class="s">"Origin TPS"</span>
+ <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"Origin TPS"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1040,7 +1159,7 @@ group.</td>
</div>
<div class="section" id="domains">
<span id="to-api-v12-cdn-domains"></span><h2>Domains<a class="headerlink" href="#domains" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/domains.json</strong></p>
+<p><strong>GET /api/1.2/cdns/domains</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -1081,21 +1200,21 @@ group.</td>
</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">"profileId"</span><span class="p">:</span> <span class="s">"5"</span><span class="p">,</span>
- <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"404"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_FOO"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for foo.domain.net"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"foo.domain.net"</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"404"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_FOO"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for foo.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"foo.domain.net"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
- <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"405"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_BAR"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for bar.domain.net"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"bar.domain.net"</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"405"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_BAR"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for bar.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"bar.domain.net"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1108,7 +1227,7 @@ group.</td>
</div>
<div class="section" id="topology">
<span id="to-api-v12-cdn-topology"></span><h2>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/:cdn_name/configs.json</strong></p>
+<p><strong>GET /api/1.2/cdns/:cdn_name/configs</strong></p>
<blockquote>
<div><p>Retrieves CDN config information.</p>
<p>Authentication Required: Yes</p>
@@ -1165,14 +1284,14 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/:name/configs/monitoring.json</strong></p>
+<p><strong>GET /api/1.2/cdns/:name/configs/monitoring</strong></p>
<blockquote>
<div><p>Retrieves CDN monitoring information.</p>
<p>Authentication Required: Yes</p>
@@ -1427,14 +1546,14 @@ profiles.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/cdns/:name/configs/routing.json</strong></p>
+<p><strong>GET /api/1.2/cdns/:name/configs/routing</strong></p>
<blockquote>
<div><p>Retrieves CDN routing information.</p>
<p>Authentication Required: Yes</p>
@@ -1842,7 +1961,7 @@ services.</td>
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
</pre></div>
</div>
<div class="line-block">
@@ -1851,7 +1970,7 @@ services.</td>
</div>
<div class="section" id="dnssec-keys">
<span id="to-api-v12-cdn-dnsseckeys"></span><h2>DNSSEC Keys<a class="headerlink" href="#dnssec-keys" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/name/:name/dnsseckeys.json</strong></p>
+<p><strong>GET /api/1.2/cdns/name/:name/dnsseckeys</strong></p>
<blockquote>
<div><p>Gets a list of dnsseckeys for a CDN and all associated Delivery Services.</p>
<p>Authentication Required: Yes</p>
@@ -1941,58 +2060,58 @@ services.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": {
- "cdn1": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "foo.kabletown.com."
- },
- "ksk": {
- "name": "foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750",
- "ttl": "60",
- dsRecord: {
- "algorithm": "5",
- "digestType": "2",
- "digest": "abc123def456"
- }
- }
- },
- "ds-01": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "ds-01.foo.kabletown.com."
- },
- "ksk": {
- "name": "ds-01.foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750"
- }
- },
- ... repeated for each ds in the cdn
- },
-}
+<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">"cdn1"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="n">dsRecord</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"algorithm"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"digestType"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"digest"</span><span class="p">:</span> <span class="s2">"abc123def456"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s2">"ds-01"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="o">...</span> <span class="n">repeated</span> <span class="k">for</span> <span class="n">each</span> <span class="n">ds</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">cdn</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/cdns/name/:name/dnsseckeys/delete.json</strong></p>
+<p><strong>GET /api/1.2/cdns/name/:name/dnsseckeys/delete</strong></p>
<blockquote>
<div><p>Delete dnssec keys for a cdn and all associated delivery services.</p>
<p>Authentication Required: Yes</p>
@@ -2038,8 +2157,8 @@ services.</td>
</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="s">"Successfully deleted dnssec keys for <cdn>"</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="s2">"Successfully deleted dnssec keys for <cdn>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -2089,13 +2208,13 @@ services.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "key": "cdn1",
- "name" "ott.kabletown.com",
- "ttl": "60",
- "kskExpirationDays": "365",
- "zskExpirationDays": "90"
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"cdn1"</span><span class="p">,</span>
+ <span class="s2">"name"</span> <span class="s2">"ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"kskExpirationDays"</span><span class="p">:</span> <span class="s2">"365"</span><span class="p">,</span>
+ <span class="s2">"zskExpirationDays"</span><span class="p">:</span> <span class="s2">"90"</span>
+<span class="p">}</span>
</pre></div>
</div>
<p><strong>Response Properties</strong></p>
@@ -2123,8 +2242,8 @@ services.</td>
</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="s">"Successfully created dnssec keys for cdn1"</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="s2">"Successfully created dnssec keys for cdn1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -2132,7 +2251,7 @@ services.</td>
</div>
<div class="section" id="ssl-keys">
<span id="to-api-v12-cdn-sslkeys"></span><h2>SSL Keys<a class="headerlink" href="#ssl-keys" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/cdns/name/:name/sslkeys.json</strong></p>
+<p><strong>GET /api/1.2/cdns/name/:name/sslkeys</strong></p>
<blockquote>
<div><p>Returns ssl certificates for all Delivery Services that are a part of the CDN.</p>
<p>Authentication Required: Yes</p>
@@ -2190,20 +2309,20 @@ services.</td>
</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">"deliveryservice"</span><span class="p">:</span> <span class="s">"ds1"</span><span class="p">,</span>
- <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"base64encodedcrt1"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"base64encodedkey1"</span>
+ <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"ds1"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"base64encodedcrt1"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"base64encodedkey1"</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">"ds2"</span><span class="p">,</span>
- <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"base64encodedcrt2"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"base64encodedkey2"</span>
+ <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"ds2"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"base64encodedcrt2"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"base64encodedkey2"</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/1.7.0/development/traffic_ops_api/v12/changelog.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/changelog.html b/docs/1.7.0/development/traffic_ops_api/v12/changelog.html
index 7d49da5..efbe137 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/changelog.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/changelog.html
@@ -235,23 +235,23 @@
</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">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
<span class="p">},</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -326,23 +326,23 @@
</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">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -377,9 +377,9 @@
</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">"newLogcount"</span><span class="p">:</span> <span class="mi">0</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">"newLogcount"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
[28/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/static_dns.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/static_dns.html b/docs/1.7.0/development/traffic_ops_api/v12/static_dns.html
index 1e1b990..d864758 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/static_dns.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/static_dns.html
@@ -235,18 +235,18 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "deliveryservice": "foo-ds",
- "ttl": "30",
- "type": "CNAME_RECORD",
- "address": "bar.foo.baz.tv.",
- "cachegroup": "us-co-denver",
- "host": "mm"
- }
- ]
-}
+<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">"deliveryservice"</span><span class="p">:</span> <span class="s2">"foo-ds"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CNAME_RECORD"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"bar.foo.baz.tv."</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span><span class="p">,</span>
+ <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"mm"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/status.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/status.html b/docs/1.7.0/development/traffic_ops_api/v12/status.html
index d67e3f6..3618cea 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/status.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/status.html
@@ -190,9 +190,9 @@
<span id="to-api-v12-status"></span><h1>Status<a class="headerlink" href="#status" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-statuses">
<span id="to-api-v12-statuses-route"></span><h2>/api/1.2/statuses<a class="headerlink" href="#api-1-2-statuses" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/statuses.json</strong></p>
+<p><strong>GET /api/1.2/statuses</strong></p>
<blockquote>
-<div><p>Retrieves a list of the server status codes available. May be useful when the status is retrieved from other APIs as a number and not a string.</p>
+<div><p>Retrieves a list of the server status codes available.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
@@ -209,65 +209,133 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>The Time / Date this server entry was last updated</td>
+<td>The id with which Traffic Ops stores this status, and references it internally</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The string equivalent of the status</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>A short description of the status</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</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">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_IGNORE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</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">"name"</span><span class="p">:</span> <span class="s2">"OFFLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</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="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"REPORTED"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.2/statuses/:id</strong></p>
+<blockquote>
+<div><p>Retrieves a server status by ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Status id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="8%" />
+<col width="76%" />
+</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>The id with which Traffic Ops stores this status, and references it internally</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The string equivalent of the status</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
<td>string</td>
<td>A short description of the status</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
- "id": "4",
- "name": "ADMIN_DOWN",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "CCR_IGNORE",
- "id": "5",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"
- },
- {
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
- "id": "1",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "OFFLINE"
- },
- {
- "id": "2",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "ONLINE"
- },
- {
- "id": "3",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
- "name": "REPORTED",
- "lastUpdated": "2013-02-13 16:34:29"
- }
- ],
-}
+<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">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</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>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/system.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/system.html b/docs/1.7.0/development/traffic_ops_api/v12/system.html
index 944c776..6c74537 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/system.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/system.html
@@ -252,16 +252,16 @@ set this parameter on a production system.</td>
</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">"parameters"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"tm.toolname"</span><span class="p">:</span> <span class="s">"Traffic Ops"</span><span class="p">,</span>
- <span class="s">"tm.infourl"</span><span class="p">:</span> <span class="s">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
- <span class="s">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s">"tm.logourl"</span><span class="p">:</span> <span class="s">"\/images\/tc_logo.png"</span><span class="p">,</span>
- <span class="s">"tm.url"</span><span class="p">:</span> <span class="s">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
- <span class="s">"tm.instance_name"</span><span class="p">:</span> <span class="s">"Kabletown CDN"</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">"parameters"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"tm.toolname"</span><span class="p">:</span> <span class="s2">"Traffic Ops"</span><span class="p">,</span>
+ <span class="s2">"tm.infourl"</span><span class="p">:</span> <span class="s2">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
+ <span class="s2">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"tm.logourl"</span><span class="p">:</span> <span class="s2">"\/images\/tc_logo.png"</span><span class="p">,</span>
+ <span class="s2">"tm.url"</span><span class="p">:</span> <span class="s2">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
+ <span class="s2">"tm.instance_name"</span><span class="p">:</span> <span class="s2">"Kabletown CDN"</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/1.7.0/development/traffic_ops_api/v12/to_extension.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/to_extension.html b/docs/1.7.0/development/traffic_ops_api/v12/to_extension.html
index a92f5ec..80a0708 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/to_extension.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/to_extension.html
@@ -251,34 +251,34 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- script_file: "ping",
- version: "1.0.0",
- name: "ILO_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
- isactive: "1",
- id: "1",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "ILO"
- },
- {
- script_file: "ping",
- version: "1.0.0",
- name: "10G_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
- isactive: "1",
- id: "2",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "10G"
- }
- ],
-}
+<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="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ilo_ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">9</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&
quot;</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"10G_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&quo
t;</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"10G"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
<div class="line-block">
@@ -342,17 +342,17 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "name": "ILO_PING",
- "version": "1.0.0",
- "info_url": "http://foo.com/bar.html",
- "script_file": "ping",
- "isactive": "1",
- "additional_config_json": "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}",
- "description": null,
- "servercheck_short_name": "ILO"
- "type": "CHECK_EXTENSION_BOOL",
-}
+<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">"ILO_PING"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="s2">"info_url"</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="s2">"script_file"</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="s2">"isactive"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"additional_config_json"</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -389,11 +389,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Check Extension loaded."</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">"Check Extension loaded."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -457,11 +457,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Extension deleted."</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">"Extension deleted."</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/1.7.0/development/traffic_ops_api/v12/topology.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/topology.html b/docs/1.7.0/development/traffic_ops_api/v12/topology.html
index 88e3e89..b5f1444 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/topology.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/topology.html
@@ -235,8 +235,8 @@
</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="s">"SUCCESS"</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="s2">"SUCCESS"</span>
<span class="p">}</span>
</pre></div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/type.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/type.html b/docs/1.7.0/development/traffic_ops_api/v12/type.html
index 4ec156c..44de028 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/type.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/type.html
@@ -190,10 +190,30 @@
<span id="to-api-v12-type"></span><h1>Types<a class="headerlink" href="#types" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-types">
<span id="to-api-v12-types-route"></span><h2>/api/1.2/types<a class="headerlink" href="#api-1-2-types" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/types.json</strong></p>
+<p><strong>GET /api/1.1/types</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
-<p>Role(s) Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="67%" />
+</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">useInTable</span></code></td>
+<td>no</td>
+<td>Filter types by the table in which they apply</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -208,39 +228,39 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</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>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</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>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<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-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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-10-23 15:28:31"</span><span class="p">,</span>
- <span class="s">"useInTable"</span><span class="p">:</span> <span class="s">"staticdnsentry"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Static DNS AAAA entry"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -248,7 +268,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/types/trimmed.json</strong></p>
+<p><strong>GET /api/1.1/types/trimmed</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -273,25 +293,100 @@
</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">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"ACTIVE_DIRECTORY"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ACTIVE_DIRECTORY"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"A_RECORD"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"A_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
+<p><strong>GET /api/1.1/types/:id</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="21%" />
+<col width="13%" />
+<col width="67%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Type ID.</td>
+</tr>
+</tbody>
+</table>
+<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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</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">"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">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</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>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/user.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/user.html b/docs/1.7.0/development/traffic_ops_api/v12/user.html
index 8fdb99e..71e28a7 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/user.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/user.html
@@ -190,17 +190,154 @@
<span id="to-api-v12-users"></span><h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-users">
<span id="to-api-v12-users-route"></span><h2>/api/1.2/users<a class="headerlink" href="#api-1-2-users" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/users.json</strong></p>
+<p><strong>GET /api/1.2/users</strong></p>
<blockquote>
<div><p>Retrieves all users.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
-<p><strong>Request Query Parameters</strong></p>
+<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="22%" />
-<col width="13%" />
-<col width="65%" />
+<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">addressLine1</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>hash</td>
+<td> </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">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</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">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">users</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/users/:id</strong></p>
+<blockquote>
+<div><p>Retrieves user by ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
@@ -209,9 +346,9 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td>username</td>
-<td>no</td>
-<td>The user you want to retrieve information for.</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>User id.</td>
</tr>
</tbody>
</table>
@@ -219,8 +356,8 @@
<table border="1" class="docutils">
<colgroup>
<col width="28%" />
-<col width="11%" />
-<col width="61%" />
+<col width="10%" />
+<col width="62%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -229,27 +366,27 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>hash</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -257,27 +394,35 @@
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">localUser</span></code></td>
-<td>boolean</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>hash</td>
+<td> </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-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">newUser</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rolename</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td>
-<td>boolean</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -285,43 +430,54 @@
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td>
<td>string</td>
<td> </td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">[</span>
- <span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"54"</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Bob Simpson"</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"bsimpson"</span><span class="p">,</span>
- <span class="s">"rolename"</span><span class="p">:</span> <span class="s">"portal"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</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="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">users</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
<span class="p">}</span>
-<span class="p">]</span>
</pre></div>
</div>
</div></blockquote>
@@ -418,25 +574,25 @@
</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">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"50"</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Callahan"</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</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">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"50"</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Callahan"</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -535,25 +691,25 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -596,11 +752,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"UserProfile was successfully updated."</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">"UserProfile was successfully updated."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -712,23 +868,23 @@
</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">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"keyword"</span><span class="p">:</span> <span class="s">"PURGE"</span><span class="p">,</span>
- <span class="s">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"assetUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"assetType"</span><span class="p">:</span> <span class="s">"file"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"PENDING"</span><span class="p">,</span>
- <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
- <span class="s">"dsXmlId"</span><span class="p">:</span> <span class="s">"ds-xml-id"</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"peewee"</span><span class="p">,</span>
- <span class="s">"parameters"</span><span class="p">:</span> <span class="s">"TTL:56h"</span><span class="p">,</span>
- <span class="s">"enteredTime"</span><span class="p">:</span> <span class="s">"2015-01-21 18:00:16"</span><span class="p">,</span>
- <span class="s">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"agent"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-21 10:45:38"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span>
+ <span class="s2">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"assetType"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"PENDING"</span><span class="p">,</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"dsXmlId"</span><span class="p">:</span> <span class="s2">"ds-xml-id"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"peewee"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:56h"</span><span class="p">,</span>
+ <span class="s2">"enteredTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 18:00:16"</span><span class="p">,</span>
+ <span class="s2">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"agent"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 10:45:38"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -742,7 +898,7 @@
<p>Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the <em>regex_revalidate</em> ATS plugin. This forces a <em>revalidation</em> of the content, rather than a new get.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">This method forces a HTTP <em>revalidation</em> of the content, and not a new <em>GET</em> - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> or <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> as applicable.</p>
+<p class="last">This method forces a HTTP <em>revalidation</em> of the content, and not a new <em>GET</em> - the origin needs to support revalidation according to the HTTP/1.2 specification, and send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> or <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> as applicable.</p>
</div>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -797,11 +953,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
- <span class="s">"regex"</span><span class="p">:</span> <span class="s">"/path/to/content.jpg"</span><span class="p">,</span>
- <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-27 11:08:37"</span><span class="p">,</span>
- <span class="s">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"regex"</span><span class="p">:</span> <span class="s2">"/path/to/content.jpg"</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-27 11:08:37"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -843,12 +999,12 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span>
+<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="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully created purge job for: ."</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">"Successfully created purge job for: ."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -888,9 +1044,9 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"u"</span><span class="p">:</span> <span class="s">"username"</span><span class="p">,</span>
- <span class="s">"p"</span><span class="p">:</span> <span class="s">"password"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"u"</span><span class="p">:</span> <span class="s2">"username"</span><span class="p">,</span>
+ <span class="s2">"p"</span><span class="p">:</span> <span class="s2">"password"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -932,11 +1088,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully logged in."</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">"Successfully logged in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -995,15 +1151,15 @@ unnecessary work.</td>
</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">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"90"</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"90"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img-secure"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"280"</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img-secure"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"280"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1039,8 +1195,8 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"t"</span><span class="p">:</span> <span class="s">"token-value"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"token-value"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1082,11 +1238,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"error"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Unauthorized, please log in."</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Unauthorized, please log in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1140,11 +1296,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"You are logged out."</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">"You are logged out."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1181,8 +1337,8 @@ password reset.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1230,11 +1386,11 @@ password reset.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully sent password reset to email 'email@email.com'"</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">"Successfully sent password reset to email 'email@email.com'"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
[14/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/cachegroup.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/cachegroup.html b/docs/latest/development/traffic_ops_api/v11/cachegroup.html
index 722c4d2..c5655d8 100644
--- a/docs/latest/development/traffic_ops_api/v11/cachegroup.html
+++ b/docs/latest/development/traffic_ops_api/v11/cachegroup.html
@@ -190,16 +190,16 @@
<span id="to-api-v11-cachegroup"></span><h1>Cache Group<a class="headerlink" href="#cache-group" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-cachegroups">
<span id="to-api-v11-cachegroups-route"></span><h2>/api/1.1/cachegroups<a class="headerlink" href="#api-1-1-cachegroups" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cachegroups.json</strong></p>
+<p><strong>GET /api/1.1/cachegroups</strong></p>
<blockquote>
<div><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="23%" />
-<col width="8%" />
-<col width="70%" />
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -208,70 +208,86 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>Longitude for the Cache Group</td>
+<td>Local unique identifier for the Cache Group</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
-<td>Identifier that refers to the ‘id’ field of different Cache Group entry.</td>
+<td>The Time / Date this entry was last updated</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
<td>string</td>
-<td>The Time / Date this entry was last updated</td>
+<td>Latitude for the Cache Group</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
<td>string</td>
-<td>The name of the type of Cache Group entry</td>
+<td>Longitude for the Cache Group</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The name of the Cache Group entry</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
<td>string</td>
-<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+<td>Parent cachegroup ID.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td>
<td>string</td>
-<td>Latitude for the Cache Group</td>
+<td>Parent cachegroup name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
<td>string</td>
-<td>Local unique identifier for the Cache Group</td>
+<td>Secondary parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
<td>string</td>
<td>Abbreviation of the Cache Group Name</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</td>
+</tr>
</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">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:32:03"</span><span class="p">,</span>
- <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
- <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dccmc"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago-1"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -281,7 +297,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cachegroups/trimmed.json</strong></p>
+<p><strong>GET /api/1.1/cachegroups/trimmed</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -306,23 +322,116 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "name": "dc-chicago"
- },
- {
- "name": "dc-cmc"
- }
- ],
-}
+<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">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</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.1/cachegroups/:id</strong></p>
+<blockquote>
+<div><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="30%" />
+<col width="7%" />
+<col width="63%" />
+</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>Local unique identifier for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">latitude</span></code></td>
+<td>string</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longitude</span></code></td>
+<td>string</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parentCachegroupId</span></code></td>
+<td>string</td>
+<td>Parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">parentCachegroupName</span></code></td>
+<td>string</td>
+<td>Parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupId</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</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">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</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">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</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.1/cachegroup/:parameter_id/parameter.json</strong></p>
+<p><strong>GET /api/1.1/cachegroup/:parameter_id/parameter</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -375,16 +484,16 @@
</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">"cachegroups"</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="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -392,7 +501,7 @@
</pre></div>
</div>
</div></blockquote>
-<p><strong>GET /api/1.1/cachegroupparameters.json</strong></p>
+<p><strong>GET /api/1.1/cachegroupparameters</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -429,23 +538,23 @@
</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">"cachegroupParameters"</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="s2">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"380"</span><span class="p">,</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"380"</span><span class="p">,</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
- <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -456,7 +565,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cachegroups/:parameter_id/parameter/available.json</strong></p>
+<p><strong>GET /api/1.1/cachegroups/:parameter_id/parameter/available</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -505,15 +614,15 @@
</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">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</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/v11/cdn.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/cdn.html b/docs/latest/development/traffic_ops_api/v11/cdn.html
index f984c91..8b4ec50 100644
--- a/docs/latest/development/traffic_ops_api/v11/cdn.html
+++ b/docs/latest/development/traffic_ops_api/v11/cdn.html
@@ -190,16 +190,16 @@
<span id="to-api-v11-cdn-health"></span><h1>CDN<a class="headerlink" href="#cdn" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-cdns">
<span id="to-api-v11-cdn-health-route"></span><h2>/api/1.1/cdns<a class="headerlink" href="#api-1-1-cdns" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns.json</strong></p>
+<p><strong>GET /api/1.1/cdns</strong></p>
<blockquote>
<div><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="24%" />
+<col width="25%" />
<col width="11%" />
-<col width="65%" />
+<col width="64%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -208,22 +208,38 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>CDN name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>int</td>
-<td>CDN id.</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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-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">"name"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="mi">1</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">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">true</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>
@@ -233,16 +249,36 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cdns/name/:name.json</strong></p>
+<p><strong>GET /api/1.1/cdns/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>CDN id.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="24%" />
+<col width="25%" />
<col width="11%" />
-<col width="65%" />
+<col width="64%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -251,22 +287,105 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>CDN name.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>int</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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">"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">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cdns/name/:name</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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>CDN name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</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>CDN id.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><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-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">"name"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="mi">1</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">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</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>
@@ -279,7 +398,7 @@
</div>
<div class="section" id="health">
<h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/health.json</strong></p>
+<p><strong>GET /api/1.1/cdns/health</strong></p>
<blockquote>
<div><p>Retrieves the health of all locations (cache groups) for all CDNs.</p>
<p>Authentication Required: Yes</p>
@@ -326,20 +445,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -350,7 +469,7 @@ group.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cdns/:name/health.json</strong></p>
+<p><strong>GET /api/1.1/cdns/:name/health</strong></p>
<blockquote>
<div><p>Retrieves the health of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -419,20 +538,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -443,7 +562,7 @@ group.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cdns/usage/overview.json</strong></p>
+<p><strong>GET /api/1.1/cdns/usage/overview</strong></p>
<blockquote>
<div><p>Retrieves the high-level CDN usage metrics.</p>
<p>Authentication Required: Yes</p>
@@ -477,17 +596,17 @@ group.</td>
</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">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
- <span class="s">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
- <span class="s">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</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">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
+ <span class="s2">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
+ <span class="s2">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
-<p><strong>GET /api/1.1/cdns/capacity.json</strong></p>
+<p><strong>GET /api/1.1/cdns/capacity</strong></p>
<blockquote>
<div><p>Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -525,12 +644,12 @@ group.</td>
</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -542,7 +661,7 @@ group.</td>
</div>
<div class="section" id="routing">
<span id="to-api-v11-cdn-routing"></span><h2>Routing<a class="headerlink" href="#routing" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/routing.json</strong></p>
+<p><strong>GET /api/1.1/cdns/routing</strong></p>
<blockquote>
<div><p>Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.</p>
<p>Authentication Required: Yes</p>
@@ -588,14 +707,14 @@ group.</td>
</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -607,7 +726,7 @@ group.</td>
</div>
<div class="section" id="metrics">
<span id="to-api-v11-cdn-metrics"></span><h2>Metrics<a class="headerlink" href="#metrics" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end.json</strong></p>
+<p><strong>GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end</strong></p>
<blockquote>
<div><p>Retrieves edge metrics of one or all locations (cache groups).</p>
<p>Authentication Required: Yes</p>
@@ -709,20 +828,20 @@ group.</td>
</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">"stats"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
- <span class="s">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
+ <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
<span class="p">},</span>
- <span class="s">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
<span class="mi">1425135900000</span><span class="p">,</span>
<span class="mf">1668.03</span>
@@ -732,7 +851,7 @@ group.</td>
<span class="n">null</span>
<span class="p">]</span>
<span class="p">],</span>
- <span class="s">"label"</span><span class="p">:</span> <span class="s">"Origin TPS"</span>
+ <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"Origin TPS"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -745,7 +864,7 @@ group.</td>
</div>
<div class="section" id="domains">
<span id="to-api-v11-cdn-domains"></span><h2>Domains<a class="headerlink" href="#domains" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/domains.json</strong></p>
+<p><strong>GET /api/1.1/cdns/domains</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -786,21 +905,21 @@ group.</td>
</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">"profileId"</span><span class="p">:</span> <span class="s">"5"</span><span class="p">,</span>
- <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"404"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_FOO"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for foo.domain.net"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"foo.domain.net"</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"404"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_FOO"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for foo.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"foo.domain.net"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
- <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"405"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_BAR"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for bar.domain.net"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"bar.domain.net"</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"405"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_BAR"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for bar.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"bar.domain.net"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -813,7 +932,7 @@ group.</td>
</div>
<div class="section" id="topology">
<span id="to-api-v11-cdn-topology"></span><h2>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/:cdn_name/configs.json</strong></p>
+<p><strong>GET /api/1.1/cdns/:cdn_name/configs</strong></p>
<blockquote>
<div><p>Retrieves CDN config information based upon the provided cdn name.</p>
<p>Authentication Required: Yes</p>
@@ -871,14 +990,14 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cdns/:name/configs/monitoring.json</strong></p>
+<p><strong>GET /api/1.1/cdns/:name/configs/monitoring</strong></p>
<blockquote>
<div><p>Retrieves CDN monitoring information.</p>
<p>Authentication Required: Yes</p>
@@ -1133,14 +1252,14 @@ profiles.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/cdns/:name/configs/routing.json</strong></p>
+<p><strong>GET /api/1.1/cdns/:name/configs/routing</strong></p>
<blockquote>
<div><p>Retrieves CDN routing information.</p>
<p>Authentication Required: Yes</p>
@@ -1555,7 +1674,7 @@ services.</td>
</div>
<div class="section" id="dnssec-keys">
<span id="to-api-v11-cdn-dnsseckeys"></span><h2>DNSSEC Keys<a class="headerlink" href="#dnssec-keys" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/cdns/name/:name/dnsseckeys.json</strong></p>
+<p><strong>GET /api/1.1/cdns/name/:name/dnsseckeys</strong></p>
<blockquote>
<div><p>Gets a list of dnsseckeys for CDN and all associated Delivery Services.
Before returning response to user, check to make sure keys aren’t expired. If they are expired, generate new ones.
@@ -1635,53 +1754,53 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": {
- "cdn1": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "foo.kabletown.com."
- },
- "ksk": {
- "name": "foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750",
- "ttl": "60"
- }
- },
- "ds-01": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "ds-01.foo.kabletown.com."
- },
- "ksk": {
- "name": "ds-01.foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750"
- }
- },
- ... repeated for each ds in the cdn
- },
-}
+<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">"cdn1"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s2">"ds-01"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="o">...</span> <span class="n">repeated</span> <span class="k">for</span> <span class="n">each</span> <span class="n">ds</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">cdn</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.1/cdns/name/:name/dnsseckeys/delete.json</strong></p>
+<p><strong>GET /api/1.1/cdns/name/:name/dnsseckeys/delete</strong></p>
<blockquote>
<div><p>Delete dnssec keys for a cdn and all associated delivery services.</p>
<p>Authentication Required: Yes</p>
@@ -1727,8 +1846,8 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</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="s">"Successfully deleted dnssec keys for <cdn>"</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="s2">"Successfully deleted dnssec keys for <cdn>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1778,13 +1897,13 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "key": "cdn1",
- "name" "ott.kabletown.com",
- "ttl": "60",
- "kskExpirationDays": "365",
- "zskExpirationDays": "90"
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"cdn1"</span><span class="p">,</span>
+ <span class="s2">"name"</span> <span class="s2">"ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"kskExpirationDays"</span><span class="p">:</span> <span class="s2">"365"</span><span class="p">,</span>
+ <span class="s2">"zskExpirationDays"</span><span class="p">:</span> <span class="s2">"90"</span>
+<span class="p">}</span>
</pre></div>
</div>
<p><strong>Response Properties</strong></p>
@@ -1812,8 +1931,8 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</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="s">"Successfully created dnssec keys for cdn1"</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="s2">"Successfully created dnssec keys for cdn1"</span>
<span class="p">}</span>
</pre></div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/changelog.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/changelog.html b/docs/latest/development/traffic_ops_api/v11/changelog.html
index 638a4dc..efd8cd7 100644
--- a/docs/latest/development/traffic_ops_api/v11/changelog.html
+++ b/docs/latest/development/traffic_ops_api/v11/changelog.html
@@ -235,23 +235,23 @@
</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">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
<span class="p">},</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -326,23 +326,23 @@
</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">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
- <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -377,9 +377,9 @@
</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">"newLogcount"</span><span class="p">:</span> <span class="mi">0</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">"newLogcount"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
[17/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/traffic_ops_extensions.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_ops_extensions.html b/docs/latest/admin/traffic_ops_extensions.html
index b90a686..c894f91 100644
--- a/docs/latest/admin/traffic_ops_extensions.html
+++ b/docs/latest/admin/traffic_ops_extensions.html
@@ -105,7 +105,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
@@ -190,7 +190,7 @@
<p>The extensions must be registered with Traffic Ops in order to display a column on the Server Check page. The list of currently registered extensions can be listed by running <code class="docutils literal"><span class="pre">/opt/traffic_ops/app/bin/extensions</span> <span class="pre">-a</span></code>.</p>
<p>The below extensions are automatically registered with the Traffic Ops database (<code class="docutils literal"><span class="pre">to_extension</span></code> table) at install time (see <code class="docutils literal"><span class="pre">traffic_ops/app/db/seeds.sql</span></code>). However, cron must still be configured to run these checks periodically.</p>
<p>The scripts are called as follows:</p>
-<div class="highlight-python"><div class="highlight"><pre>$TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
+<div class="highlight-default"><div class="highlight"><pre><span></span>$TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
where:
<name> is the type of check script
@@ -202,48 +202,48 @@ where:
<div class="section" id="example-cron-file">
<h2>Example Cron File<a class="headerlink" href="#example-cron-file" title="Permalink to this headline">�</a></h2>
<p>Edit with <code class="docutils literal"><span class="pre">crontab</span> <span class="pre">-e</span></code>. You may need to adjust the path to your $TO_HOME to match your system.</p>
-<div class="highlight-python"><div class="highlight"><pre>PERL5LIB=/opt/traffic_ops/app/local/lib/perl5:/opt/traffic_ops/app/lib
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span>
-# IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": [\"hostName\",\"domainName\"]}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"name\": \"IPv4 Ping\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: [</span><span class="se">\"</span><span class="s2">hostName</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">domainName</span><span class="se">\"</span><span class="s2">]}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">IPv4 Ping</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</s
pan><span class="o">>&</span><span class="mi">1</span>
-# IPv6 ping examples
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"name\": \"IPv6 Ping\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+<span class="c1"># IPv6 ping examples</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G6</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">IPv6 Ping</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">&g
t;&</span><span class="mi">1</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G6</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-# iLO ping
-18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"select\": \"iloIpAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"name\": \"ILO ping\", \"select\": \"iloIpAddress\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
+<span class="c1"># iLO ping</span>
+<span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">ILO</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">iloIpAddress</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">ILO</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ILO ping</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">iloIpAddress</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class
="mi">1</span>
-# MTU ping
-45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># MTU ping</span>
+<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Max Trans Unit</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o"
>>&</span><span class="mi">1</span>
+<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Max Trans Unit</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o
">>&</span><span class="mi">1</span>
-# FQDN
-27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\"" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\", \"name\": \"DNS Lookup\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># FQDN</span>
+<span class="mi">27</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToFQDNCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">FQDN</span><span class="se">\"</span><span class="s2">"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">27</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToFQDNCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">FQDN</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">DNS Lookup</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-# DSCP
-36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"cms_interface\": \"eth0\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"name\": \"Delivery Service\", \"cms_interface\": \"eth0\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># DSCP</span>
+<span class="mi">36</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToDSCPCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">DSCP</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">cms_interface</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">eth0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">36</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToDSCPCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">DSCP</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Delivery Service</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">cms_interface</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">eth0</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class
="o">>&</span><span class="mi">1</span>
-# RTR
-10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\", \"name\": \"Content Router Check\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># RTR</span>
+<span class="mi">10</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToRTRCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&quo
t;</span><span class="s2">RTR</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">10</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToRTRCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&quo
t;</span><span class="s2">RTR</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Content Router Check</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-# CHR
-*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToCHRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CHR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+<span class="c1"># CHR</span>
+<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToCHRCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </sp
an><span class="se">\"</span><span class="s2">CHR</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-# CDU
-20 * * * * root /opt/traffic_ops/app/bin/checks/ToCDUCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CDU\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+<span class="c1"># CDU</span>
+<span class="mi">20</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToCDUCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&quo
t;</span><span class="s2">CDU</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-# ORT
-40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\", \"name\": \"Operational Readiness Test\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+<span class="c1"># ORT</span>
+<span class="mi">40</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">ssh_key_edge_user</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToORTCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span cla
ss="se">\"</span><span class="s2">ORT</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<span class="mi">40</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">ssh_key_edge_user</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToORTCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span cla
ss="se">\"</span><span class="s2">ORT</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Operational Readiness Test</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
</pre></div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/traffic_ops_install.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_ops_install.html b/docs/latest/admin/traffic_ops_install.html
index 03ffa96..a3ed616 100644
--- a/docs/latest/admin/traffic_ops_install.html
+++ b/docs/latest/admin/traffic_ops_install.html
@@ -102,7 +102,7 @@
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="">Installing Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
@@ -254,13 +254,13 @@
</ol>
<blockquote>
<div><p>Example output:</p>
-<div class="highlight-python"><div class="highlight"><pre>trafficops-vm # /opt/traffic_ops/install/bin/postinstall
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">trafficops</span><span class="o">-</span><span class="n">vm</span> <span class="c1"># /opt/traffic_ops/install/bin/postinstall</span>
-This script will build and package the required Traffic Ops perl modules.
-In order to complete this operation, Development tools such as the gcc
-compiler must be installed on this machine.
+<span class="n">This</span> <span class="n">script</span> <span class="n">will</span> <span class="n">build</span> <span class="ow">and</span> <span class="n">package</span> <span class="n">the</span> <span class="n">required</span> <span class="n">Traffic</span> <span class="n">Ops</span> <span class="n">perl</span> <span class="n">modules</span><span class="o">.</span>
+<span class="n">In</span> <span class="n">order</span> <span class="n">to</span> <span class="n">complete</span> <span class="n">this</span> <span class="n">operation</span><span class="p">,</span> <span class="n">Development</span> <span class="n">tools</span> <span class="n">such</span> <span class="k">as</span> <span class="n">the</span> <span class="n">gcc</span>
+<span class="n">compiler</span> <span class="n">must</span> <span class="n">be</span> <span class="n">installed</span> <span class="n">on</span> <span class="n">this</span> <span class="n">machine</span><span class="o">.</span>
-Hit ENTER to continue:
+<span class="n">Hit</span> <span class="n">ENTER</span> <span class="n">to</span> <span class="k">continue</span><span class="p">:</span>
</pre></div>
</div>
<p>The first thing the post install will do is install additional packages needed from the yum repo.</p>
@@ -271,7 +271,7 @@ Hit ENTER to continue:
</div>
<p>If there are any prompts in this phase, please just answer with the defaults (some CPAN installs can prompt for install questions).</p>
<p>When this phase is complete, you will see:</p>
-<div class="highlight-python"><div class="highlight"><pre>...
+<div class="highlight-default"><div class="highlight"><pre><span></span>...
Successfully installed Test-Differences-0.63
Successfully installed DBIx-Class-Schema-Loader-0.07042
Successfully installed Time-HiRes-1.9726 (upgraded from 1.9719)
@@ -300,7 +300,7 @@ Database type [mysql]:
<p class="last">CentOS files note.</p>
</div>
<p>Example output:</p>
-<div class="highlight-python"><div class="highlight"><pre>Database type [mysql]:
+<div class="highlight-default"><div class="highlight"><pre><span></span>Database type [mysql]:
Database name [traffic_ops_db]:
Database server hostname IP or FQDN [localhost]:
Database port number [3306]:
@@ -426,7 +426,7 @@ seeding parameter data...
<td>The DNS domain that will be delegated to this Traffic Control CDN</td>
</tr>
<tr class="row-odd"><td>name of your CentOS 6.5 ISO kickstart tar file</td>
-<td>See <a class="reference internal" href="traffic_ops_config.html#creating-centos-kickstart"><em>Creating the CentOS Kickstart File</em></a></td>
+<td>See <a class="reference internal" href="traffic_ops_config.html#creating-centos-kickstart"><span class="std std-ref">Creating the CentOS Kickstart File</span></a></td>
</tr>
<tr class="row-even"><td>Administration username for Traffic Ops</td>
<td>The Administration (highest privilege) Traffic Ops user to create;
@@ -441,120 +441,120 @@ use this user to login for the first time and create other users</td>
<p>The postinstall script will now seed the database with some inital configuration settings for the CDN and the servers in the CDN.</p>
<p>The next phase is the download of the geo location database and configuration of information needed for SSL certificates.</p>
<p>Example output:</p>
-<div class="highlight-python"><div class="highlight"><pre>Downloading MaxMind data.
---2015-04-14 02:14:32-- http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
-Resolving geolite.maxmind.com... 141.101.115.190, 141.101.114.190, 2400:cb00:2048:1::8d65:73be, ...
-Connecting to geolite.maxmind.com|141.101.115.190|:80... connected.
-HTTP request sent, awaiting response... 200 OK
-Length: 17633433 (17M) [application/octet-stream]
-Saving to: "GeoLite2-City.mmdb.gz"
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Downloading</span> <span class="n">MaxMind</span> <span class="n">data</span><span class="o">.</span>
+<span class="o">--</span><span class="mi">2015</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">14</span> <span class="mi">02</span><span class="p">:</span><span class="mi">14</span><span class="p">:</span><span class="mi">32</span><span class="o">--</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">geolite</span><span class="o">.</span><span class="n">maxmind</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">download</span><span class="o">/</span><span class="n">geoip</span><span class="o">/</span><span class="n">database</span><span class="o">/</span><span class="n">GeoLite2</span><span class="o">-</span><span class="n">City</span><span class="o">.</span><span class="n">mmdb</span><span class="o">.</span><span class="n">gz</span>
+<span class="n">Resolving</span> <span class="n">geolite</span><span class="o">.</span><span class="n">maxmind</span><span class="o">.</span><span class="n">com</span><span class="o">...</span> <span class="mf">141.101</span><span class="o">.</span><span class="mf">115.190</span><span class="p">,</span> <span class="mf">141.101</span><span class="o">.</span><span class="mf">114.190</span><span class="p">,</span> <span class="mi">2400</span><span class="p">:</span><span class="n">cb00</span><span class="p">:</span><span class="mi">2048</span><span class="p">:</span><span class="mi">1</span><span class="p">::</span><span class="mi">8</span><span class="n">d65</span><span class="p">:</span><span class="mi">73</span><span class="n">be</span><span class="p">,</span> <span class="o">...</span>
+<span class="n">Connecting</span> <span class="n">to</span> <span class="n">geolite</span><span class="o">.</span><span class="n">maxmind</span><span class="o">.</span><span class="n">com</span><span class="o">|</span><span class="mf">141.101</span><span class="o">.</span><span class="mf">115.190</span><span class="o">|</span><span class="p">:</span><span class="mf">80.</span><span class="o">..</span> <span class="n">connected</span><span class="o">.</span>
+<span class="n">HTTP</span> <span class="n">request</span> <span class="n">sent</span><span class="p">,</span> <span class="n">awaiting</span> <span class="n">response</span><span class="o">...</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Length</span><span class="p">:</span> <span class="mi">17633433</span> <span class="p">(</span><span class="mi">17</span><span class="n">M</span><span class="p">)</span> <span class="p">[</span><span class="n">application</span><span class="o">/</span><span class="n">octet</span><span class="o">-</span><span class="n">stream</span><span class="p">]</span>
+<span class="n">Saving</span> <span class="n">to</span><span class="p">:</span> <span class="s2">"GeoLite2-City.mmdb.gz"</span>
-100%[==================================================================================================================================================================>] 17,633,433 7.03M/s in 2.4s
+<span class="mi">100</span><span class="o">%</span><span class="p">[</span><span class="o">==================================================================================================================================================================></span><span class="p">]</span> <span class="mi">17</span><span class="p">,</span><span class="mi">633</span><span class="p">,</span><span class="mi">433</span> <span class="mf">7.03</span><span class="n">M</span><span class="o">/</span><span class="n">s</span> <span class="ow">in</span> <span class="mf">2.4</span><span class="n">s</span>
-2015-04-14 02:14:35 (7.03 MB/s) - "GeoLite2-City.mmdb.gz" saved [17633433/17633433]
+<span class="mi">2015</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">14</span> <span class="mi">02</span><span class="p">:</span><span class="mi">14</span><span class="p">:</span><span class="mi">35</span> <span class="p">(</span><span class="mf">7.03</span> <span class="n">MB</span><span class="o">/</span><span class="n">s</span><span class="p">)</span> <span class="o">-</span> <span class="s2">"GeoLite2-City.mmdb.gz"</span> <span class="n">saved</span> <span class="p">[</span><span class="mi">17633433</span><span class="o">/</span><span class="mi">17633433</span><span class="p">]</span>
-Copying coverage zone file to public dir.
+<span class="n">Copying</span> <span class="n">coverage</span> <span class="n">zone</span> <span class="n">file</span> <span class="n">to</span> <span class="n">public</span> <span class="nb">dir</span><span class="o">.</span>
-Installing SSL Certificates.
+<span class="n">Installing</span> <span class="n">SSL</span> <span class="n">Certificates</span><span class="o">.</span>
- We're now running a script to generate a self signed X509 SSL certificate.
- When prompted to enter a pass phrase, just enter 'pass' each time. The
- pass phrase will be stripped from the private key before installation.
+ <span class="n">We</span><span class="s1">'re now running a script to generate a self signed X509 SSL certificate.</span>
+ <span class="n">When</span> <span class="n">prompted</span> <span class="n">to</span> <span class="n">enter</span> <span class="n">a</span> <span class="k">pass</span> <span class="n">phrase</span><span class="p">,</span> <span class="n">just</span> <span class="n">enter</span> <span class="s1">'pass'</span> <span class="n">each</span> <span class="n">time</span><span class="o">.</span> <span class="n">The</span>
+ <span class="k">pass</span> <span class="n">phrase</span> <span class="n">will</span> <span class="n">be</span> <span class="n">stripped</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">private</span> <span class="n">key</span> <span class="n">before</span> <span class="n">installation</span><span class="o">.</span>
- When prompted to enter a 'challenge password', just hit the ENTER key.
+ <span class="n">When</span> <span class="n">prompted</span> <span class="n">to</span> <span class="n">enter</span> <span class="n">a</span> <span class="s1">'challenge password'</span><span class="p">,</span> <span class="n">just</span> <span class="n">hit</span> <span class="n">the</span> <span class="n">ENTER</span> <span class="n">key</span><span class="o">.</span>
- The remaining enformation Country, State, Locality, etc... are required to
- generate a properly formatted SSL certificate.
+ <span class="n">The</span> <span class="n">remaining</span> <span class="n">enformation</span> <span class="n">Country</span><span class="p">,</span> <span class="n">State</span><span class="p">,</span> <span class="n">Locality</span><span class="p">,</span> <span class="n">etc</span><span class="o">...</span> <span class="n">are</span> <span class="n">required</span> <span class="n">to</span>
+ <span class="n">generate</span> <span class="n">a</span> <span class="n">properly</span> <span class="n">formatted</span> <span class="n">SSL</span> <span class="n">certificate</span><span class="o">.</span>
-Hit Enter when you are ready to continue:
-Postinstall SSL Certificate Creation.
+<span class="n">Hit</span> <span class="n">Enter</span> <span class="n">when</span> <span class="n">you</span> <span class="n">are</span> <span class="n">ready</span> <span class="n">to</span> <span class="k">continue</span><span class="p">:</span>
+<span class="n">Postinstall</span> <span class="n">SSL</span> <span class="n">Certificate</span> <span class="n">Creation</span><span class="o">.</span>
-Generating an RSA Private Server Key.
+<span class="n">Generating</span> <span class="n">an</span> <span class="n">RSA</span> <span class="n">Private</span> <span class="n">Server</span> <span class="n">Key</span><span class="o">.</span>
-Generating RSA private key, 1024 bit long modulus
-..........................++++++
-.....................++++++
-e is 65537 (0x10001)
-Enter pass phrase for server.key:
-Verifying - Enter pass phrase for server.key:
+<span class="n">Generating</span> <span class="n">RSA</span> <span class="n">private</span> <span class="n">key</span><span class="p">,</span> <span class="mi">1024</span> <span class="n">bit</span> <span class="n">long</span> <span class="n">modulus</span>
+<span class="o">..........................++++++</span>
+<span class="o">.....................++++++</span>
+<span class="n">e</span> <span class="ow">is</span> <span class="mi">65537</span> <span class="p">(</span><span class="mh">0x10001</span><span class="p">)</span>
+<span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="p">:</span>
+<span class="n">Verifying</span> <span class="o">-</span> <span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="p">:</span>
-The server key has been generated.
+<span class="n">The</span> <span class="n">server</span> <span class="n">key</span> <span class="n">has</span> <span class="n">been</span> <span class="n">generated</span><span class="o">.</span>
-Creating a Certificate Signing Request (CSR)
+<span class="n">Creating</span> <span class="n">a</span> <span class="n">Certificate</span> <span class="n">Signing</span> <span class="n">Request</span> <span class="p">(</span><span class="n">CSR</span><span class="p">)</span>
-Enter pass phrase for server.key:
-You are about to be asked to enter information that will be incorporated
-into your certificate request.
-What you are about to enter is what is called a Distinguished Name or a DN.
-There are quite a few fields but you can leave some blank
-For some fields there will be a default value,
-If you enter '.', the field will be left blank.
------
-Country Name (2 letter code) [XX]:US
-State or Province Name (full name) []:CO
-Locality Name (eg, city) [Default City]:Denver
-Organization Name (eg, company) [Default Company Ltd]:
-Organizational Unit Name (eg, section) []:
-Common Name (eg, your name or your server's hostname) []:
-Email Address []:
+<span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="p">:</span>
+<span class="n">You</span> <span class="n">are</span> <span class="n">about</span> <span class="n">to</span> <span class="n">be</span> <span class="n">asked</span> <span class="n">to</span> <span class="n">enter</span> <span class="n">information</span> <span class="n">that</span> <span class="n">will</span> <span class="n">be</span> <span class="n">incorporated</span>
+<span class="n">into</span> <span class="n">your</span> <span class="n">certificate</span> <span class="n">request</span><span class="o">.</span>
+<span class="n">What</span> <span class="n">you</span> <span class="n">are</span> <span class="n">about</span> <span class="n">to</span> <span class="n">enter</span> <span class="ow">is</span> <span class="n">what</span> <span class="ow">is</span> <span class="n">called</span> <span class="n">a</span> <span class="n">Distinguished</span> <span class="n">Name</span> <span class="ow">or</span> <span class="n">a</span> <span class="n">DN</span><span class="o">.</span>
+<span class="n">There</span> <span class="n">are</span> <span class="n">quite</span> <span class="n">a</span> <span class="n">few</span> <span class="n">fields</span> <span class="n">but</span> <span class="n">you</span> <span class="n">can</span> <span class="n">leave</span> <span class="n">some</span> <span class="n">blank</span>
+<span class="n">For</span> <span class="n">some</span> <span class="n">fields</span> <span class="n">there</span> <span class="n">will</span> <span class="n">be</span> <span class="n">a</span> <span class="n">default</span> <span class="n">value</span><span class="p">,</span>
+<span class="n">If</span> <span class="n">you</span> <span class="n">enter</span> <span class="s1">'.'</span><span class="p">,</span> <span class="n">the</span> <span class="n">field</span> <span class="n">will</span> <span class="n">be</span> <span class="n">left</span> <span class="n">blank</span><span class="o">.</span>
+<span class="o">-----</span>
+<span class="n">Country</span> <span class="n">Name</span> <span class="p">(</span><span class="mi">2</span> <span class="n">letter</span> <span class="n">code</span><span class="p">)</span> <span class="p">[</span><span class="n">XX</span><span class="p">]:</span><span class="n">US</span>
+<span class="n">State</span> <span class="ow">or</span> <span class="n">Province</span> <span class="n">Name</span> <span class="p">(</span><span class="n">full</span> <span class="n">name</span><span class="p">)</span> <span class="p">[]:</span><span class="n">CO</span>
+<span class="n">Locality</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">city</span><span class="p">)</span> <span class="p">[</span><span class="n">Default</span> <span class="n">City</span><span class="p">]:</span><span class="n">Denver</span>
+<span class="n">Organization</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">company</span><span class="p">)</span> <span class="p">[</span><span class="n">Default</span> <span class="n">Company</span> <span class="n">Ltd</span><span class="p">]:</span>
+<span class="n">Organizational</span> <span class="n">Unit</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">section</span><span class="p">)</span> <span class="p">[]:</span>
+<span class="n">Common</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">your</span> <span class="n">name</span> <span class="ow">or</span> <span class="n">your</span> <span class="n">server</span><span class="s1">'s hostname) []:</span>
+<span class="n">Email</span> <span class="n">Address</span> <span class="p">[]:</span>
-Please enter the following 'extra' attributes
-to be sent with your certificate request
-A challenge password []:pass
-An optional company name []:
+<span class="n">Please</span> <span class="n">enter</span> <span class="n">the</span> <span class="n">following</span> <span class="s1">'extra'</span> <span class="n">attributes</span>
+<span class="n">to</span> <span class="n">be</span> <span class="n">sent</span> <span class="k">with</span> <span class="n">your</span> <span class="n">certificate</span> <span class="n">request</span>
+<span class="n">A</span> <span class="n">challenge</span> <span class="n">password</span> <span class="p">[]:</span><span class="k">pass</span>
+<span class="n">An</span> <span class="n">optional</span> <span class="n">company</span> <span class="n">name</span> <span class="p">[]:</span>
-The Certificate Signing Request has been generated.
-Removing the pass phrase from the server key.
-Enter pass phrase for server.key.orig:
-writing RSA key
+<span class="n">The</span> <span class="n">Certificate</span> <span class="n">Signing</span> <span class="n">Request</span> <span class="n">has</span> <span class="n">been</span> <span class="n">generated</span><span class="o">.</span>
+<span class="n">Removing</span> <span class="n">the</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">server</span> <span class="n">key</span><span class="o">.</span>
+<span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">orig</span><span class="p">:</span>
+<span class="n">writing</span> <span class="n">RSA</span> <span class="n">key</span>
-The pass phrase has been removed from the server key.
+<span class="n">The</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="n">has</span> <span class="n">been</span> <span class="n">removed</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">server</span> <span class="n">key</span><span class="o">.</span>
-Generating a Self-signed certificate.
-Signature ok
-subject=/C=US/ST=CO/L=Denver/O=Default Company Ltd
-Getting Private key
+<span class="n">Generating</span> <span class="n">a</span> <span class="n">Self</span><span class="o">-</span><span class="n">signed</span> <span class="n">certificate</span><span class="o">.</span>
+<span class="n">Signature</span> <span class="n">ok</span>
+<span class="n">subject</span><span class="o">=/</span><span class="n">C</span><span class="o">=</span><span class="n">US</span><span class="o">/</span><span class="n">ST</span><span class="o">=</span><span class="n">CO</span><span class="o">/</span><span class="n">L</span><span class="o">=</span><span class="n">Denver</span><span class="o">/</span><span class="n">O</span><span class="o">=</span><span class="n">Default</span> <span class="n">Company</span> <span class="n">Ltd</span>
+<span class="n">Getting</span> <span class="n">Private</span> <span class="n">key</span>
-A server key and self signed certificate has been generated.
+<span class="n">A</span> <span class="n">server</span> <span class="n">key</span> <span class="ow">and</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">certificate</span> <span class="n">has</span> <span class="n">been</span> <span class="n">generated</span><span class="o">.</span>
-Installing the server key and server certificate.
+<span class="n">Installing</span> <span class="n">the</span> <span class="n">server</span> <span class="n">key</span> <span class="ow">and</span> <span class="n">server</span> <span class="n">certificate</span><span class="o">.</span>
-The private key has been installed.
+<span class="n">The</span> <span class="n">private</span> <span class="n">key</span> <span class="n">has</span> <span class="n">been</span> <span class="n">installed</span><span class="o">.</span>
-Installing the self signed certificate.
+<span class="n">Installing</span> <span class="n">the</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">certificate</span><span class="o">.</span>
-Saving the self signed csr.
+<span class="n">Saving</span> <span class="n">the</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">csr</span><span class="o">.</span>
- The self signed certificate has now been installed.
+ <span class="n">The</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">certificate</span> <span class="n">has</span> <span class="n">now</span> <span class="n">been</span> <span class="n">installed</span><span class="o">.</span>
- You may obtain a certificate signed by a Certificate Authority using the
- server.csr file saved in the current directory. Once you have obtained
- a signed certificate, copy it to /etc/pki/tls/certs/localhost.crt and
- restart Traffic Ops.
+ <span class="n">You</span> <span class="n">may</span> <span class="n">obtain</span> <span class="n">a</span> <span class="n">certificate</span> <span class="n">signed</span> <span class="n">by</span> <span class="n">a</span> <span class="n">Certificate</span> <span class="n">Authority</span> <span class="n">using</span> <span class="n">the</span>
+ <span class="n">server</span><span class="o">.</span><span class="n">csr</span> <span class="n">file</span> <span class="n">saved</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">current</span> <span class="n">directory</span><span class="o">.</span> <span class="n">Once</span> <span class="n">you</span> <span class="n">have</span> <span class="n">obtained</span>
+ <span class="n">a</span> <span class="n">signed</span> <span class="n">certificate</span><span class="p">,</span> <span class="n">copy</span> <span class="n">it</span> <span class="n">to</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">pki</span><span class="o">/</span><span class="n">tls</span><span class="o">/</span><span class="n">certs</span><span class="o">/</span><span class="n">localhost</span><span class="o">.</span><span class="n">crt</span> <span class="ow">and</span>
+ <span class="n">restart</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="o">.</span>
-SSL Certificates have been installed.
+<span class="n">SSL</span> <span class="n">Certificates</span> <span class="n">have</span> <span class="n">been</span> <span class="n">installed</span><span class="o">.</span>
-Starting Traffic Ops.
+<span class="n">Starting</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="o">.</span>
-Starting Traffic Ops
+<span class="n">Starting</span> <span class="n">Traffic</span> <span class="n">Ops</span>
-Subroutine TrafficOps::has redefined at /opt/traffic_ops/app/local/lib/perl5/Mojo/Base.pm line 38.
-Subroutine TrafficOps::has redefined at /opt/traffic_ops/app/local/lib/perl5/Mojo/Base.pm line 38.
-Loading config from /opt/traffic_ops/app/conf/cdn.conf
-Reading log4perl config from /opt/traffic_ops/app/conf/production/log4perl.conf
-Starting hot deployment for Hypnotoad server 32192.
+<span class="n">Subroutine</span> <span class="n">TrafficOps</span><span class="p">::</span><span class="n">has</span> <span class="n">redefined</span> <span class="n">at</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="o">/</span><span class="n">Mojo</span><span class="o">/</span><span class="n">Base</span><span class="o">.</span><span class="n">pm</span> <span class="n">line</span> <span class="mf">38.</span>
+<span class="n">Subroutine</span> <span class="n">TrafficOps</span><span class="p">::</span><span class="n">has</span> <span class="n">redefined</span> <span class="n">at</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="o">/</span><span class="n">Mojo</span><span class="o">/</span><span class="n">Base</span><span class="o">.</span><span class="n">pm</span> <span class="n">line</span> <span class="mf">38.</span>
+<span class="n">Loading</span> <span class="n">config</span> <span class="kn">from</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">conf</span><span class="o">/</span><span class="n">cdn</span><span class="o">.</span><span class="n">conf</span>
+<span class="n">Reading</span> <span class="n">log4perl</span> <span class="n">config</span> <span class="kn">from</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">conf</span><span class="o">/</span><span class="n">production</span><span class="o">/</span><span class="n">log4perl</span><span class="o">.</span><span class="n">conf</span>
+<span class="n">Starting</span> <span class="n">hot</span> <span class="n">deployment</span> <span class="k">for</span> <span class="n">Hypnotoad</span> <span class="n">server</span> <span class="mf">32192.</span>
-Waiting for Traffic Ops to start.
+<span class="n">Waiting</span> <span class="k">for</span> <span class="n">Traffic</span> <span class="n">Ops</span> <span class="n">to</span> <span class="n">start</span><span class="o">.</span>
-Shutdown Traffic Ops [y/n] [n]: n
+<span class="n">Shutdown</span> <span class="n">Traffic</span> <span class="n">Ops</span> <span class="p">[</span><span class="n">y</span><span class="o">/</span><span class="n">n</span><span class="p">]</span> <span class="p">[</span><span class="n">n</span><span class="p">]:</span> <span class="n">n</span>
-To start Traffic Ops: service traffic_ops start
-To stop Traffic Ops: service traffic_ops stop
+<span class="n">To</span> <span class="n">start</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="p">:</span> <span class="n">service</span> <span class="n">traffic_ops</span> <span class="n">start</span>
+<span class="n">To</span> <span class="n">stop</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="p">:</span> <span class="n">service</span> <span class="n">traffic_ops</span> <span class="n">stop</span>
-traffic_ops #
+<span class="n">traffic_ops</span> <span class="c1">#</span>
</pre></div>
</div>
</div></blockquote>
@@ -565,7 +565,7 @@ traffic_ops #
<ol class="arabic simple">
<li>Enter the following command:<code class="docutils literal"><span class="pre">service</span> <span class="pre">traffic_ops</span> <span class="pre">stop</span></code></li>
<li>Enter the following command:<code class="docutils literal"><span class="pre">yum</span> <span class="pre">upgrade</span> <span class="pre">traffic_ops</span></code></li>
-<li>See <a class="reference internal" href="#rl-ps"><em>Installing Traffic Ops</em></a> to run the post install.</li>
+<li>See <a class="reference internal" href="#rl-ps"><span class="std std-ref">Installing Traffic Ops</span></a> to run the post install.</li>
<li>Enter the following command:<code class="docutils literal"><span class="pre">service</span> <span class="pre">traffic_ops</span> <span class="pre">start</span></code></li>
</ol>
</div>
[04/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/profile_parameter.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/profile_parameter.html b/docs/latest/development/traffic_ops_api/v12/profile_parameter.html
new file mode 100644
index 0000000..d22618c
--- /dev/null
+++ b/docs/latest/development/traffic_ops_api/v12/profile_parameter.html
@@ -0,0 +1,887 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Profile parameters — Traffic Control 1.7 documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <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="InfluxDB" href="influxdb.html"/>
+ <link rel="prev" title="Profiles" href="profile.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../../_static/tc_logo.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../../index.html">Traffic Control 1.7</a> »</li>
+
+ <li><a href="../../index.html">Developer’s Guide</a> »</li>
+
+ <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li>
+
+ <li>Profile parameters</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../../_sources/development/traffic_ops_api/v12/profile_parameter.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">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>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="profile-parameters">
+<span id="to-api-v12-profileparameters"></span><h1>Profile parameters<a class="headerlink" href="#profile-parameters" title="Permalink to this headline">�</a></h1>
+<div class="section" id="api-1-2-profileparameters">
+<span id="to-api-v12-profileparameters-route"></span><h2>/api/1.2/profileparameters<a class="headerlink" href="#api-1-2-profileparameters" title="Permalink to this headline">�</a></h2>
+<p><strong>POST /api/1.2/profileparameters</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Associate parameter to profile.</p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Properties</strong>
+This accept two formats: single profile-parameter, profile-parameter array.</p>
+<p>Single profile-parameter format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="65%" />
+</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">profileId</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parameterId</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+<p>Profile-parameter array format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="65%" />
+</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> </td>
+<td>yes</td>
+<td>profile-parameter array.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>profileId</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>parameterId</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span>Single profile-parameter format:
+
+{
+ "profileId": 2,
+ "parameterId": 6
+}
+
+Profile-parameter array format:
+
+[
+ {
+ "profileId": 2,
+ "parameterId": 6
+ },
+ {
+ "profileId": 2,
+ "parameterId": 7
+ },
+ {
+ "profileId": 3,
+ "parameterId": 6
+ }
+]
+
+ **Response Properties**
+
+ +-------------------+---------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+=========+=====================================================+
+ | ``response`` | array | Profile-parameter associations. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>profileId`` | string | Profile id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>parameterId`` | string | Parameter id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+---------+-----------------------------------------------------+
+</pre></div>
+</div>
+<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="s2">"profileId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"7"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="s2">"alerts"</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">"Profile parameter associations were created."</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>DELETE /api/1.2/profileparameters/{:profile_id}/{:parameter_id}</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Delete a profile parameter association.</p>
+<blockquote>
+<div><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="23%" />
+<col width="13%" />
+<col width="65%" />
+</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">profile_id</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">parameter_id</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="10%" />
+<col width="66%" />
+</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>
+</div></blockquote>
+</div></blockquote>
+<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="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">"Profile parameter association was deleted."</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>POST /api/1.2/profiles/name/{:name}/parameters</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+If the profile does not exist, the API returns fail.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper. If there is parameter’s secure equals 1 in the request properties, need admin role.</p>
+<blockquote>
+<div><p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="14%" />
+<col width="70%" />
+</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>
+</div></blockquote>
+<p><strong>Request Properties</strong>
+The request properties 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="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><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>array parameters 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>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">single</span> <span class="n">parameter</span> <span class="nb">format</span> <span class="n">exampe</span><span class="p">:</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="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="p">}</span>
+
+<span class="mf">2.</span> <span class="n">array</span> <span class="nb">format</span> <span class="n">example</span><span class="p">:</span>
+<span class="p">[</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="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="p">},</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">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</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="p">}</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span>+------------------+---------+--------------------------------------------------------------------------------------+
+| Name | Type | Description |
++==================+=========+======================================================================================+
+| ``response`` | | Parameters associated with the profile. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileName`` | string | profile name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileId`` | integer | profile index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>parameters`` | array | parameters array |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>id`` | integer | parameter index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>name`` | string | parameter name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>configFile`` | string | parameter config_file |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>value`` | string | parameter value |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``alerts`` | array | A collection of alert messages. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>level`` | string | success, info, warning or error. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>text`` | string | Alert message. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``version`` | string | |
++------------------+---------+--------------------------------------------------------------------------------------+
+</pre></div>
+</div>
+<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="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span> <span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:[</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>
+ <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">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</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="s2">"1"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="s2">"alerts"</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">""</span><span class="n">Assign</span> <span class="n">parameters</span> <span class="n">successfully</span> <span class="n">to</span> <span class="n">profile</span> <span class="n">CCR1</span><span class="s2">"</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>POST /api/1.2/profiles/id/{:id}/parameters</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+If the profile does not exist, the API returns fail.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper. If there is parameter’s secure equals 1 in the request properties, need admin role.</p>
+<blockquote>
+<div><p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="14%" />
+<col width="70%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>profile name.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Request Properties</strong>
+The request properties 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="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><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>array parameters 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>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">single</span> <span class="n">parameter</span> <span class="nb">format</span> <span class="n">exampe</span><span class="p">:</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="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="p">}</span>
+
+<span class="mf">2.</span> <span class="n">array</span> <span class="nb">format</span> <span class="n">example</span><span class="p">:</span>
+<span class="p">[</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="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="p">},</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">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</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="p">}</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span>+------------------+---------+--------------------------------------------------------------------------------------+
+| Name | Type | Description |
++==================+=========+======================================================================================+
+| ``response`` | | Parameters associated with the profile. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileName`` | string | profile name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileId`` | integer | profile index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>parameters`` | array | parameters array |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>id`` | integer | parameter index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>name`` | string | parameter name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>configFile`` | string | parameter config_file |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>value`` | string | parameter value |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``alerts`` | array | A collection of alert messages. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>level`` | string | success, info, warning or error. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>text`` | string | Alert message. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``version`` | string | |
++------------------+---------+--------------------------------------------------------------------------------------+
+</pre></div>
+</div>
+<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="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span> <span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:[</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>
+ <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">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</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="s2">"1"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="s2">"alerts"</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">""</span><span class="n">Assign</span> <span class="n">parameters</span> <span class="n">successfully</span> <span class="n">to</span> <span class="n">profile</span> <span class="n">CCR1</span><span class="s2">"</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>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">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>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../../',
+ VERSION:'1.7',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/region.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/region.html b/docs/latest/development/traffic_ops_api/v12/region.html
index cb41278..b3b1570 100644
--- a/docs/latest/development/traffic_ops_api/v12/region.html
+++ b/docs/latest/development/traffic_ops_api/v12/region.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="Roles" href="role.html"/>
- <link rel="prev" title="Divisions" href="division.html"/>
+ <link rel="prev" title="InfluxDB" href="influxdb.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -180,7 +180,7 @@
<a href="role.html" class="btn btn-neutral float-right" title="Roles">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="division.html" class="btn btn-neutral" title="Divisions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="influxdb.html" class="btn btn-neutral" title="InfluxDB"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -190,7 +190,7 @@
<span id="to-api-v12-region"></span><h1>Regions<a class="headerlink" href="#regions" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-regions">
<span id="to-api-v12-regions-route"></span><h2>/api/1.2/regions<a class="headerlink" href="#api-1-2-regions" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/regions.json</strong></p>
+<p><strong>GET /api/1.1/regions</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,28 +208,227 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td> </td>
+<td>Region ID.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
-<td> </td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</td>
</tr>
</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">"name"</span><span class="p">:</span> <span class="s">"Atlanta"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"6"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Beltway"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"7"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/regions/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Region id.</td>
+</tr>
+</tbody>
+</table>
+<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>Region ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</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">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<dl class="docutils">
+<dt><strong>PUT /api/1.2/regions/:id</strong></dt>
+<dd><p class="first">Update a region</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>Region id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="31%" />
+<col width="19%" />
+<col width="50%" />
+</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 region</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">division</span></code></td>
+<td>yes</td>
+<td>The division Id</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">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</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">division</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">divisionName</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> </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">"Region 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">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+ <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -284,8 +483,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">"myregion1"</span><span class="p">,</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">"myregion1"</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -328,12 +527,12 @@
</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">'divisionName'</span><span class="p">:</span> <span class="s">'mydivision1'</span><span class="p">,</span>
- <span class="s">'divsionId'</span><span class="p">:</span> <span class="s">'4'</span><span class="p">,</span>
- <span class="s">'name'</span><span class="p">:</span> <span class="s">'myregion1'</span><span class="p">,</span>
- <span class="s">'id'</span><span class="p">:</span> <span class="s">'19'</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">'divisionName'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span>
+ <span class="s1">'divsionId'</span><span class="p">:</span> <span class="s1">'4'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'19'</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -354,7 +553,7 @@
<a href="role.html" class="btn btn-neutral float-right" title="Roles">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="division.html" class="btn btn-neutral" title="Divisions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="influxdb.html" class="btn btn-neutral" title="InfluxDB"><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/role.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/role.html b/docs/latest/development/traffic_ops_api/v12/role.html
index ac350ee..8cfd265 100644
--- a/docs/latest/development/traffic_ops_api/v12/role.html
+++ b/docs/latest/development/traffic_ops_api/v12/role.html
@@ -227,13 +227,13 @@
</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">"name"</span><span class="p">:</span> <span class="s">"read-only"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"privLevel"</span><span class="p">:</span> <span class="s">"10"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"read-only user"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"read-only"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"privLevel"</span><span class="p">:</span> <span class="s2">"10"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"read-only user"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
[03/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/server.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/server.html b/docs/latest/development/traffic_ops_api/v12/server.html
index d9ea104..1374808 100644
--- a/docs/latest/development/traffic_ops_api/v12/server.html
+++ b/docs/latest/development/traffic_ops_api/v12/server.html
@@ -190,7 +190,7 @@
<span id="to-api-v12-server"></span><h1>Server<a class="headerlink" href="#server" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-servers">
<span id="to-api-v12-servers-route"></span><h2>/api/1.2/servers<a class="headerlink" href="#api-1-2-servers" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/servers.json</strong></p>
+<p><strong>GET /api/1.2/servers</strong></p>
<blockquote>
<div><p>Retrieves properties of CDN servers.</p>
<p>Authentication Required: Yes</p>
@@ -198,9 +198,9 @@
<p><strong>Request Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="17%" />
-<col width="15%" />
-<col width="68%" />
+<col width="27%" />
+<col width="13%" />
+<col width="60%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
@@ -213,10 +213,18 @@
<td>no</td>
<td>Used to filter servers by delivery service.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>no</td>
+<td>Used to filter servers by status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>no</td>
<td>Used to filter servers by type.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>no</td>
+<td>Used to filter servers by profile.</td>
+</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
@@ -235,168 +243,467 @@
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v12-cachegroup"><em>Cache Group</em></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
<td>The domain name part of the FQDN of the cache.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
<td>The host name part of the cache.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The server id (database row number).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the lights-out-management port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway address of the lights-out-management port.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the lights-out-management port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
<td>string</td>
<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
<td>string</td>
<td>The user name for lights-out-management.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
<td>string</td>
<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
<td>string</td>
<td>The network interface name used for serving traffic.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
<td>string</td>
<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
<td>string</td>
<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
<td>string</td>
<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time and Date for the last update for this server.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the management port (optional).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway of the management port (optional).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the management port (optional).</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v12-phys-loc"><em>Physical Location</em></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v12-profile"><em>Profiles</em></a>).</td>
+<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
<td>A string indicating rack location.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
<td>string</td>
<td>The human readable name of the router.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
<td>string</td>
<td>The human readable name of the router port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="status.html#to-api-v12-status"><em>Status</em></a>).</td>
+<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
+<td>bool</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">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</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/servers/:id</strong></p>
+<blockquote>
+<div><p>Retrieves properties of a CDN server by server ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Server id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</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">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
<td>string</td>
-<td>The default HTTPS port on which the main application listens (443 for a cache in most cases).</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v12-type"><em>Types</em></a>).</td>
+<td>The server id (database row number).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
<td>string</td>
-<td>Deprecated.</td>
+<td>The IPv4 address of the lights-out-management port.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmppPasswd</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
<td>string</td>
-<td>Deprecated.</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
</tr>
</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">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
- <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
- <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
- <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
- <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
- <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
- <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
- <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-03-08 15:57:32"</span><span class="p">,</span>
- <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
- <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
- <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
- <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
- <span class="s">"xmppId"</span><span class="p">:</span> <span class="s">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
- <span class="s">"xmppPasswd"</span><span class="p">:</span> <span class="s">"**********"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -406,7 +713,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/servers/summary.json</strong></p>
+<p><strong>GET /api/1.2/servers/summary</strong></p>
<blockquote>
<div><p>Retrieves a count of CDN servers by type.</p>
<p>Authentication Required: Yes</p>
@@ -431,41 +738,41 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v12-type"><em>Types</em></a>).</td>
+<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v12-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- "count": 4,
- "type": "CCR"
- },
- {
- "count": 55,
- "type": "EDGE"
- },
- {
- "type": "MID",
- "count": 18
- },
- {
- "count": 0,
- "type": "INFLUXDB"
- },
- {
- "count": 4,
- "type": "RASCAL"
- }
-}
+<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">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CCR"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">55</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"MID"</span><span class="p">,</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">18</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"INFLUXDB"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"RASCAL"</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/servers/hostname/:name/details.json</strong></p>
+<p><strong>GET /api/1.2/servers/hostname/:name/details</strong></p>
<blockquote>
<div><p>Retrieves the details of a server.</p>
<p>Authentication Required: Yes</p>
@@ -506,11 +813,11 @@
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v12-cachegroup"><em>Cache Group</em></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v12-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryservices</span></code></td>
<td>array</td>
-<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v12-ds"><em>Delivery Service</em></a>).</td>
+<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v12-ds"><span class="std std-ref">Delivery Service</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
@@ -518,7 +825,7 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">hardwareInfo</span></code></td>
<td>hash</td>
-<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v12-hwinfo"><em>Hardware Info</em></a>).</td>
+<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v12-hwinfo"><span class="std std-ref">Hardware Info</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
@@ -594,11 +901,11 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v12-phys-loc"><em>Physical Location</em></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v12-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v12-profile"><em>Profiles</em></a>).</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v12-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
@@ -614,7 +921,7 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="status.html#to-api-v12-status"><em>Status</em></a>).</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v12-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
@@ -626,7 +933,7 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v12-type"><em>Types</em></a>).</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v12-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td>
<td>string</td>
@@ -639,93 +946,93 @@
</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">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"3"</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="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"4"</span>
<span class="p">],</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s">"YS08"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Model"</span><span class="p">:</span> <span class="s">"PowerEdge R720xd"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s">"4217A5"</span><span class="p">,</span>
- <span class="s">"Lifecycle Controller"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Manufacturer"</span><span class="p">:</span> <span class="s">"Dell Inc."</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"SysMemTotalSize"</span><span class="p">:</span> <span class="s">"196608"</span><span class="p">,</span>
- <span class="s">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s">"24"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s">"13.5.7"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s">"1.00"</span><span class="p">,</span>
- <span class="s">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s">"7.0.0.29"</span><span class="p">,</span>
- <span class="s">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s">"1.57.57"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"ServiceTag"</span><span class="p">:</span> <span class="s">"D6XPDV1"</span><span class="p">,</span>
- <span class="s">"PowerState"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s">"D903"</span><span class="p">,</span>
- <span class="s">"BIOS"</span><span class="p">:</span> <span class="s">"1.3.6"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"System CPLD"</span><span class="p">:</span> <span class="s">"1.0.3"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span>
- <span class="s">"PERC H710P Mini"</span><span class="p">:</span> <span class="s">"21.0.2-0001"</span><span class="p">,</span>
- <span class="s">"PowerCap"</span><span class="p">:</span> <span class="s">"689"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span>
- <span class="s">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s">"1.07"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s">"7.2.20"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s">"D1S2"</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s2">"YS08"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Model"</span><span class="p">:</span> <span class="s2">"PowerEdge R720xd"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s2">"4217A5"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Manufacturer"</span><span class="p">:</span> <span class="s2">"Dell Inc."</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"SysMemTotalSize"</span><span class="p">:</span> <span class="s2">"196608"</span><span class="p">,</span>
+ <span class="s2">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s2">"24"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s2">"13.5.7"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s2">"1.00"</span><span class="p">,</span>
+ <span class="s2">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s2">"7.0.0.29"</span><span class="p">,</span>
+ <span class="s2">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s2">"1.57.57"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"ServiceTag"</span><span class="p">:</span> <span class="s2">"D6XPDV1"</span><span class="p">,</span>
+ <span class="s2">"PowerState"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s2">"D903"</span><span class="p">,</span>
+ <span class="s2">"BIOS"</span><span class="p">:</span> <span class="s2">"1.3.6"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"System CPLD"</span><span class="p">:</span> <span class="s2">"1.0.3"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"PERC H710P Mini"</span><span class="p">:</span> <span class="s2">"21.0.2-0001"</span><span class="p">,</span>
+ <span class="s2">"PowerCap"</span><span class="p">:</span> <span class="s2">"689"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s2">"1.07"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s2">"7.2.20"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s2">"D1S2"</span>
<span class="p">},</span>
- <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
- <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
- <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
- <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
- <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
- <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
- <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
- <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
- <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
- <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
- <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
- <span class="s">"xmppId"</span><span class="p">:</span> <span class="s">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
- <span class="s">"xmppPasswd"</span><span class="p">:</span> <span class="s">"X"</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"xmppId"</span><span class="p">:</span> <span class="s2">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
+ <span class="s2">"xmppPasswd"</span><span class="p">:</span> <span class="s2">"X"</span>
<span class="p">}</span>
<span class="p">}</span>
@@ -773,11 +1080,11 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"host_name"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"servercheck_short_name"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"value"</span><span class="p">:</span> <span class="s">""</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"host_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -819,17 +1126,17 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>Response Example:
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Response</span> <span class="n">Example</span><span class="p">:</span>
-{
- "alerts":
- [
- {
- "level": "success",
- "text": "Server Check was successfully updated."
- }
- ],
-}
+<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">"Server Check was successfully updated."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -974,19 +1281,19 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"tc1_ats1"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"my.test.com"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"cache_group_edge"</span><span class="p">,</span>
- <span class="s">"cdnName"</span><span class="p">:</span> <span class="s">"cdn_number_1"</span><span class="p">,</span>
- <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"eth0"</span><span class="p">,</span>
- <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.74.27.188"</span><span class="p">,</span>
- <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.74.27.1"</span><span class="p">,</span>
- <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"1500"</span><span class="p">,</span>
- <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
- <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"tc1_ats1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"my.test.com"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"eth0"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.74.27.188"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.74.27.1"</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"1500"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1132,40 +1439,40 @@
</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">'xmppPasswd'</span> <span class="p">:</span> <span class="s">'**********'</span><span class="p">,</span>
- <span class="s">'profile'</span> <span class="p">:</span> <span class="s">'EDGE1_CDN1_421'</span><span class="p">,</span>
- <span class="s">'iloUsername'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'status'</span> <span class="p">:</span> <span class="s">'REPORTED'</span><span class="p">,</span>
- <span class="s">'ipAddress'</span> <span class="p">:</span> <span class="s">'10.74.27.188'</span><span class="p">,</span>
- <span class="s">'cdnId'</span> <span class="p">:</span> <span class="s">'1'</span><span class="p">,</span>
- <span class="s">'physLocation'</span> <span class="p">:</span> <span class="s">'plocation-chi-1'</span><span class="p">,</span>
- <span class="s">'cachegroup'</span> <span class="p">:</span> <span class="s">'cache_group_edge'</span><span class="p">,</span>
- <span class="s">'interfaceName'</span> <span class="p">:</span> <span class="s">'eth0'</span><span class="p">,</span>
- <span class="s">'ip6Gateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'iloPassword'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'id'</span> <span class="p">:</span> <span class="s">'1003'</span><span class="p">,</span>
- <span class="s">'routerPortName'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'lastUpdated'</span> <span class="p">:</span> <span class="s">'2016-01-25 14:16:16'</span><span class="p">,</span>
- <span class="s">'ipNetmask'</span> <span class="p">:</span> <span class="s">'255.255.255.0'</span><span class="p">,</span>
- <span class="s">'ipGateway'</span> <span class="p">:</span> <span class="s">'10.74.27.1'</span><span class="p">,</span>
- <span class="s">'tcpPort'</span> <span class="p">:</span> <span class="s">'80'</span><span class="p">,</span>
- <span class="s">'httpsPort'</span> <span class="p">:</span> <span class="s">'443'</span><span class="p">,</span>
- <span class="s">'mgmtIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'ip6Address'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'interfaceMtu'</span> <span class="p">:</span> <span class="s">'1500'</span><span class="p">,</span>
- <span class="s">'iloIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'hostName'</span> <span class="p">:</span> <span class="s">'tc1_ats1'</span><span class="p">,</span>
- <span class="s">'xmppId'</span> <span class="p">:</span> <span class="s">'tc1_ats1'</span><span class="p">,</span>
- <span class="s">'rack'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'mgmtIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'iloIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'mgmtIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'type'</span> <span class="p">:</span> <span class="s">'EDGE'</span><span class="p">,</span>
- <span class="s">'domainName'</span> <span class="p">:</span> <span class="s">'my.test.com'</span><span class="p">,</span>
- <span class="s">'iloIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'routerHostName'</span> <span class="p">:</span> <span class="n">null</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s1">'response'</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'xmppPasswd'</span> <span class="p">:</span> <span class="s1">'**********'</span><span class="p">,</span>
+ <span class="s1">'profile'</span> <span class="p">:</span> <span class="s1">'EDGE1_CDN1_421'</span><span class="p">,</span>
+ <span class="s1">'iloUsername'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'status'</span> <span class="p">:</span> <span class="s1">'REPORTED'</span><span class="p">,</span>
+ <span class="s1">'ipAddress'</span> <span class="p">:</span> <span class="s1">'10.74.27.188'</span><span class="p">,</span>
+ <span class="s1">'cdnId'</span> <span class="p">:</span> <span class="s1">'1'</span><span class="p">,</span>
+ <span class="s1">'physLocation'</span> <span class="p">:</span> <span class="s1">'plocation-chi-1'</span><span class="p">,</span>
+ <span class="s1">'cachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'interfaceName'</span> <span class="p">:</span> <span class="s1">'eth0'</span><span class="p">,</span>
+ <span class="s1">'ip6Gateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'iloPassword'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'1003'</span><span class="p">,</span>
+ <span class="s1">'routerPortName'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 14:16:16'</span><span class="p">,</span>
+ <span class="s1">'ipNetmask'</span> <span class="p">:</span> <span class="s1">'255.255.255.0'</span><span class="p">,</span>
+ <span class="s1">'ipGateway'</span> <span class="p">:</span> <span class="s1">'10.74.27.1'</span><span class="p">,</span>
+ <span class="s1">'tcpPort'</span> <span class="p">:</span> <span class="s1">'80'</span><span class="p">,</span>
+ <span class="s1">'httpsPort'</span> <span class="p">:</span> <span class="s1">'443'</span><span class="p">,</span>
+ <span class="s1">'mgmtIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'ip6Address'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'interfaceMtu'</span> <span class="p">:</span> <span class="s1">'1500'</span><span class="p">,</span>
+ <span class="s1">'iloIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'hostName'</span> <span class="p">:</span> <span class="s1">'tc1_ats1'</span><span class="p">,</span>
+ <span class="s1">'xmppId'</span> <span class="p">:</span> <span class="s1">'tc1_ats1'</span><span class="p">,</span>
+ <span class="s1">'rack'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'mgmtIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'iloIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'mgmtIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'type'</span> <span class="p">:</span> <span class="s1">'EDGE'</span><span cl
<TRUNCATED>
[29/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/server.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/server.html b/docs/1.7.0/development/traffic_ops_api/v12/server.html
index d9ea104..1374808 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/server.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/server.html
@@ -190,7 +190,7 @@
<span id="to-api-v12-server"></span><h1>Server<a class="headerlink" href="#server" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-servers">
<span id="to-api-v12-servers-route"></span><h2>/api/1.2/servers<a class="headerlink" href="#api-1-2-servers" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/servers.json</strong></p>
+<p><strong>GET /api/1.2/servers</strong></p>
<blockquote>
<div><p>Retrieves properties of CDN servers.</p>
<p>Authentication Required: Yes</p>
@@ -198,9 +198,9 @@
<p><strong>Request Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="17%" />
-<col width="15%" />
-<col width="68%" />
+<col width="27%" />
+<col width="13%" />
+<col width="60%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
@@ -213,10 +213,18 @@
<td>no</td>
<td>Used to filter servers by delivery service.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>no</td>
+<td>Used to filter servers by status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>no</td>
<td>Used to filter servers by type.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>no</td>
+<td>Used to filter servers by profile.</td>
+</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
@@ -235,168 +243,467 @@
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v12-cachegroup"><em>Cache Group</em></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
<td>The domain name part of the FQDN of the cache.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
<td>The host name part of the cache.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The server id (database row number).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the lights-out-management port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway address of the lights-out-management port.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the lights-out-management port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
<td>string</td>
<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
<td>string</td>
<td>The user name for lights-out-management.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
<td>string</td>
<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
<td>string</td>
<td>The network interface name used for serving traffic.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
<td>string</td>
<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
<td>string</td>
<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
<td>string</td>
<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time and Date for the last update for this server.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the management port (optional).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway of the management port (optional).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the management port (optional).</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v12-phys-loc"><em>Physical Location</em></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v12-profile"><em>Profiles</em></a>).</td>
+<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
<td>A string indicating rack location.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
<td>string</td>
<td>The human readable name of the router.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
<td>string</td>
<td>The human readable name of the router port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="status.html#to-api-v12-status"><em>Status</em></a>).</td>
+<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
+<td>bool</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">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</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/servers/:id</strong></p>
+<blockquote>
+<div><p>Retrieves properties of a CDN server by server ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Server id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</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">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
<td>string</td>
-<td>The default HTTPS port on which the main application listens (443 for a cache in most cases).</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v12-type"><em>Types</em></a>).</td>
+<td>The server id (database row number).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
<td>string</td>
-<td>Deprecated.</td>
+<td>The IPv4 address of the lights-out-management port.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmppPasswd</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
<td>string</td>
-<td>Deprecated.</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
</tr>
</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">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
- <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
- <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
- <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
- <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
- <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
- <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
- <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-03-08 15:57:32"</span><span class="p">,</span>
- <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
- <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
- <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
- <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
- <span class="s">"xmppId"</span><span class="p">:</span> <span class="s">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
- <span class="s">"xmppPasswd"</span><span class="p">:</span> <span class="s">"**********"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -406,7 +713,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/servers/summary.json</strong></p>
+<p><strong>GET /api/1.2/servers/summary</strong></p>
<blockquote>
<div><p>Retrieves a count of CDN servers by type.</p>
<p>Authentication Required: Yes</p>
@@ -431,41 +738,41 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v12-type"><em>Types</em></a>).</td>
+<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v12-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- "count": 4,
- "type": "CCR"
- },
- {
- "count": 55,
- "type": "EDGE"
- },
- {
- "type": "MID",
- "count": 18
- },
- {
- "count": 0,
- "type": "INFLUXDB"
- },
- {
- "count": 4,
- "type": "RASCAL"
- }
-}
+<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">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CCR"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">55</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"MID"</span><span class="p">,</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">18</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"INFLUXDB"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"RASCAL"</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/servers/hostname/:name/details.json</strong></p>
+<p><strong>GET /api/1.2/servers/hostname/:name/details</strong></p>
<blockquote>
<div><p>Retrieves the details of a server.</p>
<p>Authentication Required: Yes</p>
@@ -506,11 +813,11 @@
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v12-cachegroup"><em>Cache Group</em></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v12-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryservices</span></code></td>
<td>array</td>
-<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v12-ds"><em>Delivery Service</em></a>).</td>
+<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v12-ds"><span class="std std-ref">Delivery Service</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
@@ -518,7 +825,7 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">hardwareInfo</span></code></td>
<td>hash</td>
-<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v12-hwinfo"><em>Hardware Info</em></a>).</td>
+<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v12-hwinfo"><span class="std std-ref">Hardware Info</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
@@ -594,11 +901,11 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v12-phys-loc"><em>Physical Location</em></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v12-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v12-profile"><em>Profiles</em></a>).</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v12-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
@@ -614,7 +921,7 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="status.html#to-api-v12-status"><em>Status</em></a>).</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v12-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
@@ -626,7 +933,7 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v12-type"><em>Types</em></a>).</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v12-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td>
<td>string</td>
@@ -639,93 +946,93 @@
</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">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"3"</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="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"4"</span>
<span class="p">],</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s">"YS08"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Model"</span><span class="p">:</span> <span class="s">"PowerEdge R720xd"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s">"4217A5"</span><span class="p">,</span>
- <span class="s">"Lifecycle Controller"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Manufacturer"</span><span class="p">:</span> <span class="s">"Dell Inc."</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"SysMemTotalSize"</span><span class="p">:</span> <span class="s">"196608"</span><span class="p">,</span>
- <span class="s">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s">"24"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s">"13.5.7"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s">"1.00"</span><span class="p">,</span>
- <span class="s">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s">"7.0.0.29"</span><span class="p">,</span>
- <span class="s">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s">"1.57.57"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"ServiceTag"</span><span class="p">:</span> <span class="s">"D6XPDV1"</span><span class="p">,</span>
- <span class="s">"PowerState"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s">"D903"</span><span class="p">,</span>
- <span class="s">"BIOS"</span><span class="p">:</span> <span class="s">"1.3.6"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"System CPLD"</span><span class="p">:</span> <span class="s">"1.0.3"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span>
- <span class="s">"PERC H710P Mini"</span><span class="p">:</span> <span class="s">"21.0.2-0001"</span><span class="p">,</span>
- <span class="s">"PowerCap"</span><span class="p">:</span> <span class="s">"689"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span>
- <span class="s">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s">"1.07"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s">"7.2.20"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s">"D1S2"</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s2">"YS08"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Model"</span><span class="p">:</span> <span class="s2">"PowerEdge R720xd"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s2">"4217A5"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Manufacturer"</span><span class="p">:</span> <span class="s2">"Dell Inc."</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"SysMemTotalSize"</span><span class="p">:</span> <span class="s2">"196608"</span><span class="p">,</span>
+ <span class="s2">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s2">"24"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s2">"13.5.7"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s2">"1.00"</span><span class="p">,</span>
+ <span class="s2">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s2">"7.0.0.29"</span><span class="p">,</span>
+ <span class="s2">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s2">"1.57.57"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"ServiceTag"</span><span class="p">:</span> <span class="s2">"D6XPDV1"</span><span class="p">,</span>
+ <span class="s2">"PowerState"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s2">"D903"</span><span class="p">,</span>
+ <span class="s2">"BIOS"</span><span class="p">:</span> <span class="s2">"1.3.6"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"System CPLD"</span><span class="p">:</span> <span class="s2">"1.0.3"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"PERC H710P Mini"</span><span class="p">:</span> <span class="s2">"21.0.2-0001"</span><span class="p">,</span>
+ <span class="s2">"PowerCap"</span><span class="p">:</span> <span class="s2">"689"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s2">"1.07"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s2">"7.2.20"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s2">"D1S2"</span>
<span class="p">},</span>
- <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
- <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
- <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
- <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
- <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
- <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
- <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
- <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
- <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
- <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
- <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
- <span class="s">"xmppId"</span><span class="p">:</span> <span class="s">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
- <span class="s">"xmppPasswd"</span><span class="p">:</span> <span class="s">"X"</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"xmppId"</span><span class="p">:</span> <span class="s2">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
+ <span class="s2">"xmppPasswd"</span><span class="p">:</span> <span class="s2">"X"</span>
<span class="p">}</span>
<span class="p">}</span>
@@ -773,11 +1080,11 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"host_name"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"servercheck_short_name"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"value"</span><span class="p">:</span> <span class="s">""</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"host_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -819,17 +1126,17 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>Response Example:
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Response</span> <span class="n">Example</span><span class="p">:</span>
-{
- "alerts":
- [
- {
- "level": "success",
- "text": "Server Check was successfully updated."
- }
- ],
-}
+<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">"Server Check was successfully updated."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -974,19 +1281,19 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"tc1_ats1"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"my.test.com"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"cache_group_edge"</span><span class="p">,</span>
- <span class="s">"cdnName"</span><span class="p">:</span> <span class="s">"cdn_number_1"</span><span class="p">,</span>
- <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"eth0"</span><span class="p">,</span>
- <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.74.27.188"</span><span class="p">,</span>
- <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.74.27.1"</span><span class="p">,</span>
- <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"1500"</span><span class="p">,</span>
- <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
- <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"tc1_ats1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"my.test.com"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"eth0"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.74.27.188"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.74.27.1"</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"1500"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1132,40 +1439,40 @@
</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">'xmppPasswd'</span> <span class="p">:</span> <span class="s">'**********'</span><span class="p">,</span>
- <span class="s">'profile'</span> <span class="p">:</span> <span class="s">'EDGE1_CDN1_421'</span><span class="p">,</span>
- <span class="s">'iloUsername'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'status'</span> <span class="p">:</span> <span class="s">'REPORTED'</span><span class="p">,</span>
- <span class="s">'ipAddress'</span> <span class="p">:</span> <span class="s">'10.74.27.188'</span><span class="p">,</span>
- <span class="s">'cdnId'</span> <span class="p">:</span> <span class="s">'1'</span><span class="p">,</span>
- <span class="s">'physLocation'</span> <span class="p">:</span> <span class="s">'plocation-chi-1'</span><span class="p">,</span>
- <span class="s">'cachegroup'</span> <span class="p">:</span> <span class="s">'cache_group_edge'</span><span class="p">,</span>
- <span class="s">'interfaceName'</span> <span class="p">:</span> <span class="s">'eth0'</span><span class="p">,</span>
- <span class="s">'ip6Gateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'iloPassword'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'id'</span> <span class="p">:</span> <span class="s">'1003'</span><span class="p">,</span>
- <span class="s">'routerPortName'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'lastUpdated'</span> <span class="p">:</span> <span class="s">'2016-01-25 14:16:16'</span><span class="p">,</span>
- <span class="s">'ipNetmask'</span> <span class="p">:</span> <span class="s">'255.255.255.0'</span><span class="p">,</span>
- <span class="s">'ipGateway'</span> <span class="p">:</span> <span class="s">'10.74.27.1'</span><span class="p">,</span>
- <span class="s">'tcpPort'</span> <span class="p">:</span> <span class="s">'80'</span><span class="p">,</span>
- <span class="s">'httpsPort'</span> <span class="p">:</span> <span class="s">'443'</span><span class="p">,</span>
- <span class="s">'mgmtIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'ip6Address'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'interfaceMtu'</span> <span class="p">:</span> <span class="s">'1500'</span><span class="p">,</span>
- <span class="s">'iloIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'hostName'</span> <span class="p">:</span> <span class="s">'tc1_ats1'</span><span class="p">,</span>
- <span class="s">'xmppId'</span> <span class="p">:</span> <span class="s">'tc1_ats1'</span><span class="p">,</span>
- <span class="s">'rack'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'mgmtIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'iloIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'mgmtIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'type'</span> <span class="p">:</span> <span class="s">'EDGE'</span><span class="p">,</span>
- <span class="s">'domainName'</span> <span class="p">:</span> <span class="s">'my.test.com'</span><span class="p">,</span>
- <span class="s">'iloIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">'routerHostName'</span> <span class="p">:</span> <span class="n">null</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s1">'response'</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'xmppPasswd'</span> <span class="p">:</span> <span class="s1">'**********'</span><span class="p">,</span>
+ <span class="s1">'profile'</span> <span class="p">:</span> <span class="s1">'EDGE1_CDN1_421'</span><span class="p">,</span>
+ <span class="s1">'iloUsername'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'status'</span> <span class="p">:</span> <span class="s1">'REPORTED'</span><span class="p">,</span>
+ <span class="s1">'ipAddress'</span> <span class="p">:</span> <span class="s1">'10.74.27.188'</span><span class="p">,</span>
+ <span class="s1">'cdnId'</span> <span class="p">:</span> <span class="s1">'1'</span><span class="p">,</span>
+ <span class="s1">'physLocation'</span> <span class="p">:</span> <span class="s1">'plocation-chi-1'</span><span class="p">,</span>
+ <span class="s1">'cachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'interfaceName'</span> <span class="p">:</span> <span class="s1">'eth0'</span><span class="p">,</span>
+ <span class="s1">'ip6Gateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'iloPassword'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'1003'</span><span class="p">,</span>
+ <span class="s1">'routerPortName'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 14:16:16'</span><span class="p">,</span>
+ <span class="s1">'ipNetmask'</span> <span class="p">:</span> <span class="s1">'255.255.255.0'</span><span class="p">,</span>
+ <span class="s1">'ipGateway'</span> <span class="p">:</span> <span class="s1">'10.74.27.1'</span><span class="p">,</span>
+ <span class="s1">'tcpPort'</span> <span class="p">:</span> <span class="s1">'80'</span><span class="p">,</span>
+ <span class="s1">'httpsPort'</span> <span class="p">:</span> <span class="s1">'443'</span><span class="p">,</span>
+ <span class="s1">'mgmtIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'ip6Address'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'interfaceMtu'</span> <span class="p">:</span> <span class="s1">'1500'</span><span class="p">,</span>
+ <span class="s1">'iloIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'hostName'</span> <span class="p">:</span> <span class="s1">'tc1_ats1'</span><span class="p">,</span>
+ <span class="s1">'xmppId'</span> <span class="p">:</span> <span class="s1">'tc1_ats1'</span><span class="p">,</span>
+ <span class="s1">'rack'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'mgmtIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'iloIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'mgmtIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'type'</span> <span class="p">:</span> <span class="s1">'EDGE'</span><span class="
<TRUNCATED>
[45/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/server.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/server.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/server.txt
index 4e308fb..316f126 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/server.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/server.txt
@@ -24,7 +24,7 @@ Server
/api/1.2/servers
++++++++++++++++
-**GET /api/1.2/servers.json**
+**GET /api/1.2/servers**
Retrieves properties of CDN servers.
@@ -34,12 +34,172 @@ Server
**Request Query Parameters**
+ +--------------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +====================+==========+=============================================+
+ | ``dsId`` | no | Used to filter servers by delivery service. |
+ +--------------------+----------+---------------------------------------------+
+ | ``status`` | no | Used to filter servers by status. |
+ +--------------------+----------+---------------------------------------------+
+ | ``type`` | no | Used to filter servers by type. |
+ +--------------------+----------+---------------------------------------------+
+ | ``profileId`` | no | Used to filter servers by profile. |
+ +--------------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/servers/:id**
+
+ Retrieves properties of a CDN server by server ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+-----------+----------+---------------------------------------------+
| Name | Required | Description |
+===========+==========+=============================================+
- | ``dsId`` | no | Used to filter servers by delivery service. |
- +-----------+----------+---------------------------------------------+
- | ``type`` | no | Used to filter servers by type. |
+ | ``id`` | yes | Server id. |
+-----------+----------+---------------------------------------------+
**Response Properties**
@@ -47,12 +207,22 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+====================+========+============================================================================================================+
- | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v12-cachegroup`). |
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``domainName`` | string | The domain name part of the FQDN of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``hostName`` | string | The host name part of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``id`` | string | The server id (database row number). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
@@ -87,9 +257,17 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``physLocation`` | string | The physical location name (see :ref:`to-api-v12-phys-loc`). |
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profile`` | string | The assigned profile name (see :ref:`to-api-v12-profile`). |
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``rack`` | string | A string indicating rack location. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
@@ -97,17 +275,17 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``routerPortName`` | string | The human readable name of the router port. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``status`` | string | The Status string (See :ref:`to-api-v12-status`). |
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The default HTTPS port on which the main application listens (443 for a cache in most cases). |
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The name of the type of this server (see :ref:`to-api-v12-type`). |
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppId`` | string | Deprecated. |
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppPasswd`` | string | Deprecated. |
+ | ``updPending`` | bool | |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -116,7 +294,11 @@ Server
"response": [
{
"cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
"domainName": "chi.kabletown.net",
+ "guid": null,
"hostName": "atsec-chi-00",
"id": "19",
"iloIpAddress": "172.16.2.6",
@@ -135,27 +317,30 @@ Server
"mgmtIpAddress": "",
"mgmtIpGateway": "",
"mgmtIpNetmask": "",
+ "offlineReason": "N/A",
"physLocation": "plocation-chi-1",
+ "physLocationId": "9",
"profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
"rack": "RR 119.02",
"routerHostName": "rtr-chi.kabletown.net",
"routerPortName": "2",
"status": "ONLINE",
+ "statusId": "6",
"tcpPort": "80",
"httpsPort": "443",
"type": "EDGE",
- "xmppId": "atsec-chi-00-dummyxmpp",
- "xmppPasswd": "**********"
- },
- {
- ... more server data
+ "typeId": "3",
+ "updPending": false
}
]
}
|
-**GET /api/1.2/servers/summary.json**
+
+**GET /api/1.2/servers/summary**
Retrieves a count of CDN servers by type.
@@ -201,7 +386,7 @@ Server
|
-**GET /api/1.2/servers/hostname/:name/details.json**
+**GET /api/1.2/servers/hostname/:name/details**
Retrieves the details of a server.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/status.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/status.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/status.txt
index 401f088..e374527 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/status.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/status.txt
@@ -24,9 +24,9 @@ Status
/api/1.2/statuses
+++++++++++++++++
-**GET /api/1.2/statuses.json**
+**GET /api/1.2/statuses**
- Retrieves a list of the server status codes available. May be useful when the status is retrieved from other APIs as a number and not a string.
+ Retrieves a list of the server status codes available.
Authentication Required: Yes
@@ -37,51 +37,92 @@ Status
+-----------------+--------+--------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=================+========+================================================================================+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+-----------------+--------+--------------------------------------------------------------------------------+
| ``name`` | string | The string equivalent of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
- | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
- +-----------------+--------+--------------------------------------------------------------------------------+
| ``description`` | string | A short description of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"id": "4",
"name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"lastUpdated": "2013-02-13 16:34:29"
},
{
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "CCR_IGNORE",
"id": "5",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"
+ "name": "CCR_IGNORE",
+ "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
"id": "1",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "OFFLINE"
+ "name": "OFFLINE",
+ "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "2",
+ "name": "ONLINE",
"description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "ONLINE"
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "3",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
"name": "REPORTED",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
"lastUpdated": "2013-02-13 16:34:29"
}
- ],
+ ]
}
-|
+**GET /api/1.2/statuses/:id**
+
+ Retrieves a server status by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Status id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/type.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/type.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/type.txt
index 90c2eeb..4238fc7 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/type.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/type.txt
@@ -24,45 +24,54 @@ Types
/api/1.2/types
++++++++++++++
-**GET /api/1.2/types.json**
+**GET /api/1.1/types**
Authentication Required: Yes
- Role(s) Required: Yes
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``useInTable`` | no | Filter types by the table in which they apply |
+ +----------------+----------+----------------------------------------------------+
**Response Properties**
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
+ |``id`` | string | |
+----------------------+--------+------------------------------------------------+
|``name`` | string | |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
|``description`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "lastUpdated": "2013-10-23 15:28:31",
- "useInTable": "staticdnsentry",
- "name": "AAAA_RECORD",
"id": "22",
- "description": "Static DNS AAAA entry"
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
}
- ],
+ ]
}
+
|
-**GET /api/1.2/types/trimmed.json**
+**GET /api/1.1/types/trimmed**
Authentication Required: Yes
@@ -95,4 +104,49 @@ Types
],
}
+**GET /api/1.1/types/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``id`` | yes | Type ID. |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/user.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/user.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/user.txt
index 8292a6b..e81292a 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/user.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/user.txt
@@ -24,7 +24,7 @@ Users
/api/1.2/users
++++++++++++++
-**GET /api/1.2/users.json**
+**GET /api/1.2/users**
Retrieves all users.
@@ -32,82 +32,184 @@ Users
Role(s) Required: None
- **Request Query Parameters**
+ **Response Properties**
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- | username | no | The user you want to retrieve information for. |
- +-----------------+----------+---------------------------------------------------+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/users/:id**
+
+ Retrieves user by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | User id. |
+ +-----------+----------+---------------------------------------------+
**Response Properties**
- +----------------------+---------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+=========+================================================+
- |``email`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``id`` | hash | |
- +----------------------+---------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``localUser`` | boolean | |
- +----------------------+---------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``rolename`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``newUser`` | boolean | |
- +----------------------+---------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``addressLine1`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+---------+------------------------------------------------+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
-
- [
- {
- "email": "email@email.com",
- "city": "",
- "id": "54",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "Bob Simpson",
- "localUser": false,
- "uid": "0",
- "stateOrProvince": "",
- "username": "bsimpson",
- "rolename": "portal",
- "newUser": true,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "postalCode": "",
- "gid": "0"
- }
- ]
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
|
+
**GET /api/1.2/user/current.json**
Retrieves the profile for the authenticated user.
@@ -365,7 +467,7 @@ Users
Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
-.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
+.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.2 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
Authentication Required: Yes
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_stats.txt b/docs/1.7.0/_sources/development/traffic_stats.txt
index 186f13a..4c78bec 100644
--- a/docs/1.7.0/_sources/development/traffic_stats.txt
+++ b/docs/1.7.0/_sources/development/traffic_stats.txt
@@ -1,18 +1,18 @@
-..
+..
.. Copyright 2015 Comcast Cable Communications Management, LLC
-..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
Traffic Stats
*************
@@ -25,20 +25,21 @@ Software Requirements
=====================
To work on Traffic Stats you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
- * `Go 1.5.x or above <https://golang.org/doc/install>`_
+ * `Go 1.7.x or above <https://golang.org/doc/install>`_
* Access to a working instance of Traffic Ops
* Access to a working instance of Traffic Monitor
- * `InfluxDb version 0.10.0 or greater <https://influxdb.com/download/index.html>`_
+ * `InfluxDb version 1.0.0 or greater <https://influxdb.com/download/index.html>`_
Traffic Stats Project Tree Overview
=====================================
* **traffic_control/traffic_stats** - contains Go source files and Files used to create the Traffic Stats rpm.
* **traffic_control/traffic_stats/grafana/** - contains a javascript file which is installed on the grafana server. This allows Traffic Ops to create custom dashboards for Delivery Services, Caches, etc.
+ * **traffic_control/traffic_stats/influxdb_tools/** - contains one tool to create the databases and retention policies needed by Traffic Stats as well as continuous queries to downsample data; contains another tool to sync downsampled data between influxdb instances. This is is helpful if you have multiple instances and they get out of sync with data.
-Go Formatting Conventions
+Go Formatting Conventions
============================
-In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code.
+In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code. It is also recommended to use `Go lint <https://github.com/golang/lint>`_.
Installing The Developer Environment
====================================
@@ -54,6 +55,5 @@ To install the Traffic Ops Developer environment:
Test Cases
==========
- Currently there are not automated tests for Traffic Stats :(.
- We hope to remedy this problem very soon!
+ Currently there are no automated tests for Traffic Stats :( but pull requests are always welcome to fix this problem!
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/overview/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/overview/traffic_stats.txt b/docs/1.7.0/_sources/overview/traffic_stats.txt
index 7468166..874b10d 100644
--- a/docs/1.7.0/_sources/overview/traffic_stats.txt
+++ b/docs/1.7.0/_sources/overview/traffic_stats.txt
@@ -1,18 +1,18 @@
-..
+..
.. Copyright 2015 Comcast Cable Communications Management, LLC
-..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
.. _reference-label-tc-ts:
.. |arrow| image:: fwda.png
@@ -20,14 +20,14 @@
Traffic Stats
=============
-Traffic Stats is a program written in `Golang <http://golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by `Grafana <http://grafana.org>`_ which are linked from Traffic Ops as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API's and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served.
+Traffic Stats is a program written in `Golang <http://golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less). The data from InfluxDb is then used to drive graphs created by `Grafana <http://grafana.org>`_ - which are linked to from Traffic Ops - as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API's and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served.
Stat data is stored in three different databases:
- cache_stats: The cache_stats database is used to store data gathered from edge caches. The `measurements <https://influxdb.com/docs/v0.9/concepts/glossary.html#measurement>`_ stored by cache are: bandwidth, maxKbps, and client_connections (ats.proxy.process.http.current_client_connections). Cache Data is stored with `tags <https://influxdb.com/docs/v0.9/concepts/glossary.html#tag>`_ for hostname, cachegroup, and CDN. Data can be queried using tags.
- - deliveryservice_stats: The deliveryservice_stats database is used to store data for delivery services. The measurements stored by delivery service are: kbps, status_4xx, status_5xx, tps_2xx, tps_3xx, tps_4xx, tps_5xx, and tps_total. Delivery Service stats are stored with tags for cachegroup, CDN, and Deliveryservice xml_id.
+ - deliveryservice_stats: The deliveryservice_stats database is used to store data for delivery services. The measurements stored by delivery service are: kbps, status_4xx, status_5xx, tps_2xx, tps_3xx, tps_4xx, tps_5xx, and tps_total. Delivery Service stats are stored with tags for cachegroup, CDN, and Deliveryservice xml_id.
- daily_stats: The daily_stats database is used to store summary data for daily activities. The stats that are currently summarized are Max Bandwidth and Bytes Served and they are stored by CDN.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_static/basic.css
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_static/basic.css b/docs/1.7.0/_static/basic.css
index 9fa77d8..2b513f0 100644
--- a/docs/1.7.0/_static/basic.css
+++ b/docs/1.7.0/_static/basic.css
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -52,6 +52,8 @@ div.sphinxsidebar {
width: 230px;
margin-left: -100%;
font-size: 90%;
+ word-wrap: break-word;
+ overflow-wrap : break-word;
}
div.sphinxsidebar ul {
@@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] {
width: 170px;
}
-div.sphinxsidebar #searchbox input[type="submit"] {
- width: 30px;
-}
-
img {
border: 0;
max-width: 100%;
@@ -187,6 +185,13 @@ div.genindex-jumpbox {
/* -- general body styles --------------------------------------------------- */
+div.body p, div.body dd, div.body li, div.body blockquote {
+ -moz-hyphens: auto;
+ -ms-hyphens: auto;
+ -webkit-hyphens: auto;
+ hyphens: auto;
+}
+
a.headerlink {
visibility: hidden;
}
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_static/doctools.js
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_static/doctools.js b/docs/1.7.0/_static/doctools.js
index c7bfe76..8163495 100644
--- a/docs/1.7.0/_static/doctools.js
+++ b/docs/1.7.0/_static/doctools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -124,6 +124,7 @@ var Documentation = {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
+
},
/**
@@ -252,6 +253,29 @@ var Documentation = {
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
+ },
+
+ initOnKeyListeners: function() {
+ $(document).keyup(function(event) {
+ var activeElementType = document.activeElement.tagName;
+ // don't navigate when in search box or textarea
+ if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
+ switch (event.keyCode) {
+ case 37: // left
+ var prevHref = $('link[rel="prev"]').prop('href');
+ if (prevHref) {
+ window.location.href = prevHref;
+ return false;
+ }
+ case 39: // right
+ var nextHref = $('link[rel="next"]').prop('href');
+ if (nextHref) {
+ window.location.href = nextHref;
+ return false;
+ }
+ }
+ }
+ });
}
};
@@ -260,4 +284,4 @@ _ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
-});
+});
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_static/pygments.css
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_static/pygments.css b/docs/1.7.0/_static/pygments.css
index 57eadc0..8213e90 100644
--- a/docs/1.7.0/_static/pygments.css
+++ b/docs/1.7.0/_static/pygments.css
@@ -4,8 +4,10 @@
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
+.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
+.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_static/searchtools.js
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_static/searchtools.js b/docs/1.7.0/_static/searchtools.js
index 0e794fd..066857c 100644
--- a/docs/1.7.0/_static/searchtools.js
+++ b/docs/1.7.0/_static/searchtools.js
@@ -2,14 +2,15 @@
* searchtools.js_t
* ~~~~~~~~~~~~~~~~
*
- * Sphinx JavaScript utilties for the full-text search.
+ * Sphinx JavaScript utilities for the full-text search.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
+/* Non-minified version JS is _stemmer.js if file is provided */
/**
* Porter Stemmer
*/
@@ -373,8 +374,7 @@ var Search = {
}
// lookup as search terms in fulltext
- results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term))
- .concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title));
+ results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
// let the scorer override scores with a custom scoring function
if (Scorer.score) {
@@ -538,23 +538,47 @@ var Search = {
/**
* search for full-text terms in the index
*/
- performTermsSearch : function(searchterms, excluded, terms, score) {
+ performTermsSearch : function(searchterms, excluded, terms, titleterms) {
var filenames = this._index.filenames;
var titles = this._index.titles;
- var i, j, file, files;
+ var i, j, file;
var fileMap = {};
+ var scoreMap = {};
var results = [];
// perform the search on the required terms
for (i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
+ var files = [];
+ var _o = [
+ {files: terms[word], score: Scorer.term},
+ {files: titleterms[word], score: Scorer.title}
+ ];
+
// no match but word was a required one
- if ((files = terms[word]) === undefined)
+ if ($u.every(_o, function(o){return o.files === undefined;})) {
break;
- if (files.length === undefined) {
- files = [files];
}
+ // found search word in contents
+ $u.each(_o, function(o) {
+ var _files = o.files;
+ if (_files === undefined)
+ return
+
+ if (_files.length === undefined)
+ _files = [_files];
+ files = files.concat(_files);
+
+ // set score for the word in each file to Scorer.term
+ for (j = 0; j < _files.length; j++) {
+ file = _files[j];
+ if (!(file in scoreMap))
+ scoreMap[file] = {}
+ scoreMap[file][word] = o.score;
+ }
+ });
+
// create the mapping
for (j = 0; j < files.length; j++) {
file = files[j];
@@ -576,7 +600,9 @@ var Search = {
// ensure that none of the excluded terms is in the search result
for (i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
- $u.contains(terms[excluded[i]] || [], file)) {
+ titleterms[excluded[i]] == file ||
+ $u.contains(terms[excluded[i]] || [], file) ||
+ $u.contains(titleterms[excluded[i]] || [], file)) {
valid = false;
break;
}
@@ -584,6 +610,9 @@ var Search = {
// if we have still a valid result we can add it to the result list
if (valid) {
+ // select one (max) score for the file.
+ // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
+ var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
results.push([filenames[file], titles[file], '', null, score]);
}
}
@@ -594,7 +623,7 @@ var Search = {
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
- * words. the first one is used to find the occurance, the
+ * words. the first one is used to find the occurrence, the
* latter for highlighting it.
*/
makeSearchSummary : function(text, keywords, hlwords) {
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_static/websupport.js
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_static/websupport.js b/docs/1.7.0/_static/websupport.js
index 28d65db..98e7f40 100644
--- a/docs/1.7.0/_static/websupport.js
+++ b/docs/1.7.0/_static/websupport.js
@@ -2,9 +2,9 @@
* websupport.js
* ~~~~~~~~~~~~~
*
- * sphinx.websupport utilties for all documentation.
+ * sphinx.websupport utilities for all documentation.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/index.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/index.html b/docs/1.7.0/admin/index.html
index 29592cc..511c279 100644
--- a/docs/1.7.0/admin/index.html
+++ b/docs/1.7.0/admin/index.html
@@ -100,7 +100,7 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="">Administrator’s Guide</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
@@ -300,12 +300,19 @@
<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#id3">Configuration</a></li>
</ul>
</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#https-for-http-type-delivery-services">HTTPS for Http Type Delivery Services</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#protocol-options">Protocol Options</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#certificate-retrieval">Certificate Retrieval</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#certificate-chain-ordering">Certificate Chain Ordering</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#suggested-way-of-setting-up-an-https-delivery-service">Suggested Way of Setting up an HTTPS Delivery Service</a></li>
+</ul>
+</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#configuration">Configuration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#id1">InfluxDb Tools</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#id2">InfluxDb Tools</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a><ul>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/quick_howto/dnssec.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/quick_howto/dnssec.html b/docs/1.7.0/admin/quick_howto/dnssec.html
index d359f38..c5c25f2 100644
--- a/docs/1.7.0/admin/quick_howto/dnssec.html
+++ b/docs/1.7.0/admin/quick_howto/dnssec.html
@@ -199,7 +199,7 @@
<ol class="arabic simple">
<li>Go to Tools->Manage DNSSEC Keys choose a CDN and click Manage DNSSEC Keys</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec01.png"><img alt="../../_images/dnssec01.png" class="align-center" src="../../_images/dnssec01.png" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec01.png"><img alt="../../_images/dnssec01.png" class="align-center" src="../../_images/dnssec01.png" style="width: 1100.0px; height: 280.0px;" /></a>
<ol class="arabic" start="2">
<li><p class="first">Generate keys for a CDN by clicking Generate Keys then entering the following information:</p>
<blockquote>
@@ -213,20 +213,20 @@
<p>Depending upon the number of Delivery Services in the CDN, generating DNSSEC keys may take serveral seconds.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec02.png"><img alt="../../_images/dnssec02.png" class="align-center" src="../../_images/dnssec02.png" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec02.png"><img alt="../../_images/dnssec02.png" class="align-center" src="../../_images/dnssec02.png" style="width: 747.0px; height: 454.0px;" /></a>
<ol class="arabic" start="3">
<li><p class="first">In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN’s domain (e.g. If the CDN’s domain is ‘cdn.kabletown.net’ the parent zone is ‘kabletown.net’).</p>
<p>If you control your parent zone you can enter this information yourself, otherwise you will need to work with your DNS team to get the DS Record added to the parent zone.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec03.png"><img alt="../../_images/dnssec03.png" class="align-center" src="../../_images/dnssec03.png" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec03.png"><img alt="../../_images/dnssec03.png" class="align-center" src="../../_images/dnssec03.png" style="width: 499.1px; height: 190.4px;" /></a>
<ol class="arabic" start="4">
<li><p class="first">Once DS Record information has been added to the parent zone, DNSSEC needs to be activated for the CDN so that Traffic Router will sign responses.</p>
<p>Click on Tools -> Manage DNSSEC Keys -> Choose your CDN -> On the Manage DNSSEC Keys page click the activate DNSSEC Keys button.</p>
<p>This will add a ‘dnssec.enabled = “true”’ entry to CRConfig for the chosen CDN.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec04.png"><img alt="../../_images/dnssec04.png" class="align-center" src="../../_images/dnssec04.png" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec04.png"><img alt="../../_images/dnssec04.png" class="align-center" src="../../_images/dnssec04.png" style="width: 554.4px; height: 422.8px;" /></a>
<ol class="arabic" start="5">
<li><p class="first">DNSSEC should now be active on your CDN and Traffic Router should be signing responses.</p>
<blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/quick_howto/federations.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/quick_howto/federations.html b/docs/1.7.0/admin/quick_howto/federations.html
index 241305c..2fb7c80 100644
--- a/docs/1.7.0/admin/quick_howto/federations.html
+++ b/docs/1.7.0/admin/quick_howto/federations.html
@@ -200,24 +200,24 @@
</div></blockquote>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation01.png"><img alt="../../_images/federation01.png" class="align-center" src="../../_images/federation01.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation01.png"><img alt="../../_images/federation01.png" class="align-center" src="../../_images/federation01.png" style="width: 804.0px; height: 690.0px;" /></a>
<ol class="arabic simple" start="2">
<li>As a user with admin priveleges, create a Federation Mapping by going to Delivery Services -> Federations and then clicking ‘Add Federation Mapping’</li>
<li>Choose the Delivery Service for the federation to be mapped to and assign it to the Federation User; click Add.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation02.png"><img alt="../../_images/federation02.png" class="align-center" src="../../_images/federation02.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation02.png"><img alt="../../_images/federation02.png" class="align-center" src="../../_images/federation02.png" style="width: 766.0px; height: 494.0px;" /></a>
<ol class="arabic" start="4">
<li><p class="first">After the Federation is added, Traffic Ops will display the Federation.</p>
<p>Changes can be made at this time or the Federation can be deleted. Notice that no resolvers have been added to the fedeation yet. This can only be done by the federation user created in step 1.</p>
<p>If no further action is necessary, the Close button will close the window and display the list of all Federations.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation03.png"><img alt="../../_images/federation03.png" class="align-center" src="../../_images/federation03.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation03.png"><img alt="../../_images/federation03.png" class="align-center" src="../../_images/federation03.png" style="width: 806.0px; height: 886.0px;" /></a>
<p><strong>The Federation user can now add resolvers to the Federation Mapping in Traffic Ops.</strong></p>
<ol class="arabic" start="5">
<li><p class="first">The federation user logs to traffic ops and stores the mojolicious cookie. The mojolicious cookie can be obtained manually using the debug tools on a web browser or via curl.</p>
<p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
HTTP/1.1 200 OK
Date: Wed, 02 Dec 2015 21:12:06 GMT
@@ -239,7 +239,7 @@ Access-Control-Allow-Origin: http://localhost:8080
<li><p class="first">The federation user sends a request to Traffic Ops to add IPV4 and/or IPV6 resolvers</p>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
{"federations": [
{ "deliveryService": "images-c1",
"mappings":
@@ -271,12 +271,12 @@ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
<li><p class="first">The resolvers added by the federation user will now visible in Traffic Ops.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation04.png"><img alt="../../_images/federation04.png" class="align-center" src="../../_images/federation04.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation04.png"><img alt="../../_images/federation04.png" class="align-center" src="../../_images/federation04.png" style="width: 802.0px; height: 875.0px;" /></a>
<ol class="arabic" start="8">
<li><p class="first">Any requests made from a client that resolves to one of the federation resolvers will now be given a CNAME from Traffic Router.</p>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ dig @tr.kabletown.net edge.images-c1.kabletown.net
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ dig @tr.kabletown.net edge.images-c1.kabletown.net
; <<>> DiG 9.7.3-RedHat-9.7.3-2.el6 <<>> @tr.kabletown.net edge.images-c1.kabletown.net
; (1 server found)
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/admin/quick_howto/index.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/admin/quick_howto/index.html b/docs/1.7.0/admin/quick_howto/index.html
index 1a6d192..3bcfa76 100644
--- a/docs/1.7.0/admin/quick_howto/index.html
+++ b/docs/1.7.0/admin/quick_howto/index.html
@@ -112,7 +112,7 @@
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_vault.html">Traffic Vault Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Quick How To Guides</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Quick How To Guides</a></li>
</ul>
</li>
</ul>
[33/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v12/deliveryservice.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/deliveryservice.html b/docs/1.7.0/development/traffic_ops_api/v12/deliveryservice.html
index 1062d1e..0b6cf22 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/deliveryservice.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/deliveryservice.html
@@ -198,82 +198,76 @@
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="10%" />
-<col width="3%" />
-<col width="50%" />
-<col width="38%" />
+<col width="15%" />
+<col width="5%" />
+<col width="80%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
-<th class="head"> </th>
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
-<td>string</td>
-<td>Unique string that describes this deliveryservice.</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">active</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
<td>bool</td>
<td>true if active, false if inactive.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
<td>string</td>
<td>Cache URL rule to apply to this delivery service.</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
-<td>string</td>
-<td><ul class="first last simple">
-<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
-<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
-<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
-</ul>
-</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
-<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
<td>string</td>
<td>The path portion of the URL to check this deliveryservice for health.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS bypass response.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
<td>string</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
<td>string</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
@@ -283,128 +277,137 @@ globalMaxMbps traffic on this deliveryservice.</td>
<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
routing to the content by Traffic Router.</p>
</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectURL</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
<td>string</td>
-<td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td>
<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
<td>string</td>
<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">headerRewrite</span></code></td>
-<td>string</td>
-<td>The EDGE header rewrite actions to perform.</td>
-<td> </td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
<td>string</td>
<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The deliveryservice id (database row number).</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
<td>string</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
<td>bool</td>
<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
<td>Description field 2.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
<td>string</td>
<td>Description field 2.</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
<td>array</td>
<td>Array of matchList hashes.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
-<td>The type of MatchList (one of :ref:to-api-v12-types use_in_table=’regex’).</td>
-<td> </td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
<td>string</td>
<td>The set Number of the matchList.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
<td>string</td>
<td>The regexp for the matchList.</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
<td>string</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
<td>string</td>
-<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
-<td> </td>
+<td>The MID header rewrite actions to perform.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
<td>string</td>
-<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
-<td> </td>
+<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
<td>string</td>
-<td>The MID header rewrite actions to perform.</td>
-<td> </td>
+<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
-<td>string</td>
-<td> </td>
-<td>Is the Multi Site Origin feature enabled for this delivery service. See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
<td>The origin server base URL (FQDN when used in this instance, includes the
protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
+<td>string</td>
<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
<td>string</td>
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
<td>string</td>
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
-<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
<td>string</td>
@@ -414,17 +417,28 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<li>2: drop query string at edge, and do not use it in the cache-key.</li>
</ul>
</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
<td>string</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
-<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
<td>string</td>
<td>Additional raw remap line text.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
<td>bool</td>
@@ -433,91 +447,112 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<li>true: token based auth is enabled for this deliveryservice.</li>
</ul>
</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
<td>string</td>
-<td><p class="first">How to treat range requests:</p>
-<ul class="last simple">
-<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
-<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
-<li>2 Use the cache_range_requests plugin.</li>
-</ul>
-</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
-<td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
-<td>array</td>
-<td>Entry points into the CDN for this deliveryservice.</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
<td> </td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "geoLimitRedirectURL": "",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
- },
- { .. },
- { .. }
- ],
-}
+<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">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="o">..</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/deliveryservices/:id.json</strong></p>
+<p><strong>GET /api/1.2/deliveryservices/:id</strong></p>
<blockquote>
<div><p>Retrieves a specific delivery service. See also <a class="reference external" href="http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
@@ -536,58 +571,65 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
-<td>string</td>
-<td>Unique string that describes this deliveryservice.</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">active</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
<td>bool</td>
<td>true if active, false if inactive.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
<td>string</td>
<td>Cache URL rule to apply to this delivery service.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
-<td>string</td>
-<td><ul class="first last simple">
-<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
-<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
-<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
-</ul>
-</td>
-</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
<td>string</td>
<td>The path portion of the URL to check this deliveryservice for health.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS bypass response.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
<td>string</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
<td>string</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
@@ -598,9 +640,13 @@ globalMaxMbps traffic on this deliveryservice.</td>
routing to the content by Traffic Router.</p>
</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectURL</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
<td>string</td>
-<td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
+<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
@@ -613,27 +659,35 @@ dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliver
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">headerRewrite</span></code></td>
-<td>string</td>
-<td>The EDGE header rewrite actions to perform.</td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
<td>string</td>
<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The deliveryservice id (database row number).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
<td>string</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
<td>bool</td>
<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
@@ -652,7 +706,7 @@ globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
-<td>The type of MatchList (one of :ref:to-api-v12-types use_in_table=’regex’).</td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
<td>string</td>
@@ -667,32 +721,57 @@ globalMaxMbps traffic on this deliveryservice.</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
<td>string</td>
<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
<td>string</td>
<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
-<td>string</td>
-<td>The MID header rewrite actions to perform.</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
<td>The origin server base URL (FQDN when used in this instance, includes the
protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
<td>string</td>
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
<td>string</td>
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
<td>string</td>
<td><ul class="first last simple">
<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
@@ -701,15 +780,29 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</ul>
</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
<td>string</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
<td>string</td>
<td>Additional raw remap line text.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
<td>bool</td>
<td><ul class="first last simple">
<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
@@ -717,80 +810,108 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</ul>
</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
<td>string</td>
-<td><p class="first">How to treat range requests:</p>
-<ul class="last simple">
-<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
-<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
-<li>2 Use the cache_range_requests plugin.</li>
-</ul>
-</td>
+<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
-<td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td>
+<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
<td>string</td>
-<td>Entry points in to the CDN for this deliveryservice.</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
</tr>
</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">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"protocol"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"ccrDnsTtl"</span><span class="p">:</span> <span class="s">"3600"</span><span class="p">,</span>
- <span class="s">"checkPath"</span><span class="p">:</span> <span class="s">"/crossdomain.xml"</span><span class="p">,</span>
- <span class="s">"dnsBypassIp"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"dnsBypassIp6"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"dnsBypassTtl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"dscp"</span><span class="p">:</span> <span class="s">"40"</span><span class="p">,</span>
- <span class="s">"geoLimit"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"geoLimitRedirectURL"</span><span class="p">:</span><span class="s">""</span><span class="p">,</span>
- <span class="s">"globalMaxMbps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"globalMaxTps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"headerRewrite"</span><span class="p">:</span> <span class="s">"add-header X-Powered-By: KABLETOWN [L]"</span><span class="p">,</span>
- <span class="s">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="s">"add-header X-Powered-By: KABLETOWN [L]"</span><span class="p">,</span>
- <span class="s">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"httpBypassFqdn"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"rangeRequestHandling"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"12"</span><span class="p">,</span>
- <span class="s">"infoUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"longDesc"</span><span class="p">:</span> <span class="s">"long_desc"</span><span class="p">,</span>
- <span class="s">"longDesc1"</span><span class="p">:</span> <span class="s">"long_desc_1"</span><span class="p">,</span>
- <span class="s">"longDesc2"</span><span class="p">:</span> <span class="s">"long_desc_2"</span><span class="p">,</span>
- <span class="s">"matchList"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HOST_REGEXP"</span><span class="p">,</span>
- <span class="s">"setNumber"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">.images</span><span class="se">\\</span><span class="s">..*"</span>
- <span class="p">}</span>
- <span class="p">],</span>
- <span class="s">"maxDnsAnswers"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"missLat"</span><span class="p">:</span> <span class="s">"41.881944"</span><span class="p">,</span>
- <span class="s">"missLong"</span><span class="p">:</span> <span class="s">"-87.627778"</span><span class="p">,</span>
- <span class="s">"orgServerFqdn"</span><span class="p">:</span> <span class="s">"http://cdl.origin.kabletown.net"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for cdn2.comcast.net"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"EDGE_CDN2"</span><span class="p">,</span>
- <span class="s">"qstringIgnore"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"signed"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HTTP"</span><span class="p">,</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"cdl-c2"</span><span class="p">,</span>
- <span class="s">"exampleURLs"</span><span class="p">:</span> <span class="p">[]</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</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>
</div>
<div class="section" id="health">
<span id="to-api-v12-ds-health"></span><h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">�</a></h2>
@@ -822,6 +943,14 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">>destination</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -840,15 +969,18 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</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">"failover"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
- <span class="s">"destination"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"enabled"</span><span class="p">:</span> <span class="n">false</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">"failover"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
+ <span class="s2">"destination"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"location"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"DNS"</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="s2">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">},</span>
- <span class="s">"enabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -904,20 +1036,20 @@ group.</td>
</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">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</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="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</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">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -990,12 +1122,12 @@ delivery service that is down for maintenance.</td>
</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</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">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1032,9 +1164,9 @@ delivery service that is down for maintenance.</td>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="11%" />
+<col width="16%" />
<col width="5%" />
-<col width="83%" />
+<col width="79%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -1061,24 +1193,40 @@ delivery service that is down for maintenance.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cz</span></code></td>
<td>number</td>
-<td>The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF hit.</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF (coverage zone file) hit.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dsr</span></code></td>
<td>number</td>
<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the
client to the overflow CDN.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">fed</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to a federated CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionalAlternate</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to the alternate
+regional geoblocking URL.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalDenied</span></code></td>
+<td>number</td>
+<td>The percent of Traffic Router requests for this deliveryservice denied due to geolocation policy.</td>
+</tr>
</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</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">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"fed"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"regionalAlternate"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"regionalDenied"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1144,22 +1292,22 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
- <span class="s">"orderby"</span><span class="p">:</span> <span class="s">"deliveryservice"</span><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">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"orderby"</span><span class="p">:</span> <span class="s2">"deliveryservice"</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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:43"</span><span class="p">,</span>
- <span class="s">"server"</span><span class="p">:</span> <span class="s">"20"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:43"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"20"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:44"</span><span class="p">,</span>
- <span class="s">"server"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:44"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">},</span>
<span class="p">],</span>
- <span class="s">"limit"</span><span class="p">:</span> <span class="mi">2</span>
+ <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">2</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1268,20 +1416,20 @@ client to the overflow CDN.</td>
</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
<span class="p">},</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1391,20 +1539,20 @@ client to the overflow CDN.</td>
</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</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">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
<span class="p">},</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1478,8 +1626,8 @@ client to the overflow CDN.</td>
</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="s">"Successfully deleted ssl keys for <xml_id>"</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="s2">"Successfully deleted ssl keys for <xml_id>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1541,20 +1689,20 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"ds-01"</span><span class="p">,</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN Engineering"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
- <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"some_key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"some_csr"</span><span class="p">,</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"some_crt"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN Engineering"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span>
<span class="p">},</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"Kabletown"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"Kabletown"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1588,8 +1736,8 @@ client to the overflow CDN.</td>
</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="s">"Successfully created ssl keys for ds-01"</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="s2">"Successfully created ssl keys for ds-01"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1639,13 +1787,13 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"key"</span><s
<TRUNCATED>
[36/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/system.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/system.html b/docs/1.7.0/development/traffic_ops_api/v11/system.html
index aabcf08..340a58a 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/system.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/system.html
@@ -252,16 +252,16 @@ set this parameter on a production system.</td>
</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">"parameters"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"tm.toolname"</span><span class="p">:</span> <span class="s">"Traffic Ops"</span><span class="p">,</span>
- <span class="s">"tm.infourl"</span><span class="p">:</span> <span class="s">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
- <span class="s">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s">"tm.logourl"</span><span class="p">:</span> <span class="s">"\/images\/tc_logo.png"</span><span class="p">,</span>
- <span class="s">"tm.url"</span><span class="p">:</span> <span class="s">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
- <span class="s">"tm.instance_name"</span><span class="p">:</span> <span class="s">"Kabletown CDN"</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">"parameters"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"tm.toolname"</span><span class="p">:</span> <span class="s2">"Traffic Ops"</span><span class="p">,</span>
+ <span class="s2">"tm.infourl"</span><span class="p">:</span> <span class="s2">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
+ <span class="s2">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"tm.logourl"</span><span class="p">:</span> <span class="s2">"\/images\/tc_logo.png"</span><span class="p">,</span>
+ <span class="s2">"tm.url"</span><span class="p">:</span> <span class="s2">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
+ <span class="s2">"tm.instance_name"</span><span class="p">:</span> <span class="s2">"Kabletown CDN"</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/1.7.0/development/traffic_ops_api/v11/to_extension.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/to_extension.html b/docs/1.7.0/development/traffic_ops_api/v11/to_extension.html
index c3ce3a9..b9b6d61 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/to_extension.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/to_extension.html
@@ -251,34 +251,34 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- script_file: "ping",
- version: "1.0.0",
- name: "ILO_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
- isactive: "1",
- id: "1",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "ILO"
- },
- {
- script_file: "ping",
- version: "1.0.0",
- name: "10G_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
- isactive: "1",
- id: "2",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "10G"
- }
- ],
-}
+<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="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ilo_ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">9</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&
quot;</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"10G_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&quo
t;</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"10G"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
<div class="line-block">
@@ -342,17 +342,17 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "name": "ILO_PING",
- "version": "1.0.0",
- "info_url": "http://foo.com/bar.html",
- "script_file": "ping",
- "isactive": "1",
- "additional_config_json": "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}",
- "description": null,
- "servercheck_short_name": "ILO"
- "type": "CHECK_EXTENSION_BOOL",
-}
+<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">"ILO_PING"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="s2">"info_url"</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="s2">"script_file"</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="s2">"isactive"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"additional_config_json"</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -389,11 +389,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Check Extension loaded."</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">"Check Extension loaded."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -457,11 +457,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Extension deleted."</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">"Extension deleted."</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/1.7.0/development/traffic_ops_api/v11/type.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/type.html b/docs/1.7.0/development/traffic_ops_api/v11/type.html
index 8ffc8c4..1c527fe 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/type.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/type.html
@@ -190,10 +190,30 @@
<span id="to-api-v11-type"></span><h1>Types<a class="headerlink" href="#types" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-types">
<span id="to-api-v11-types-route"></span><h2>/api/1.1/types<a class="headerlink" href="#api-1-1-types" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/types.json</strong></p>
+<p><strong>GET /api/1.1/types</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="67%" />
+</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">useInTable</span></code></td>
+<td>no</td>
+<td>Filter types by the table in which they apply</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -208,39 +228,39 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</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>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</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>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<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-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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-10-23 15:28:31"</span><span class="p">,</span>
- <span class="s">"useInTable"</span><span class="p">:</span> <span class="s">"staticdnsentry"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Static DNS AAAA entry"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -248,7 +268,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/types/trimmed.json</strong></p>
+<p><strong>GET /api/1.1/types/trimmed</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -273,25 +293,103 @@
</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">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"ACTIVE_DIRECTORY"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ACTIVE_DIRECTORY"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"A_RECORD"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"A_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
+<p><strong>GET /api/1.1/types/:id</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="21%" />
+<col width="13%" />
+<col width="67%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Type ID.</td>
+</tr>
+</tbody>
+</table>
+<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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</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">"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">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</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>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/user.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/user.html b/docs/1.7.0/development/traffic_ops_api/v11/user.html
index 63fe7ac..3b51cb1 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/user.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/user.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-users"></span><h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-users">
<span id="to-api-v11-users-route"></span><h2>/api/1.1/users<a class="headerlink" href="#api-1-1-users" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/users.json</strong></p>
+<p><strong>GET /api/1.1/users</strong></p>
<blockquote>
<div><p>Retrieves all users.</p>
<p>Authentication Required: Yes</p>
@@ -209,11 +209,35 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -221,23 +245,39 @@
<td>hash</td>
<td> </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">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">localUser</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -249,15 +289,140 @@
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rolename</span></code></td>
+</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">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">users</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.1/users/:id</strong></p>
+<blockquote>
+<div><p>Retrieves user by ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>User id.</td>
+</tr>
+</tbody>
+</table>
+<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">addressLine1</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>hash</td>
+<td> </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">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -265,50 +430,58 @@
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td>
<td>string</td>
<td> </td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">[</span>
- <span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"54"</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Bob Simpson"</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"bsimpson"</span><span class="p">,</span>
- <span class="s">"rolename"</span><span class="p">:</span> <span class="s">"portal"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</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="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</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.1/user/current.json</strong></p>
+<p><strong>GET /api/1.1/user/current</strong></p>
<blockquote>
<div><p>Retrieves the profile for the authenticated user.</p>
<p>Authentication Required: Yes</p>
@@ -398,25 +571,25 @@
</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">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"50"</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Callahan"</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</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">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"50"</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Callahan"</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -515,25 +688,25 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -571,11 +744,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"UserProfile was successfully updated."</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">"UserProfile was successfully updated."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -687,23 +860,23 @@
</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">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"keyword"</span><span class="p">:</span> <span class="s">"PURGE"</span><span class="p">,</span>
- <span class="s">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"assetUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"assetType"</span><span class="p">:</span> <span class="s">"file"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"PENDING"</span><span class="p">,</span>
- <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
- <span class="s">"dsXmlId"</span><span class="p">:</span> <span class="s">"ds-xml-id"</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"peewee"</span><span class="p">,</span>
- <span class="s">"parameters"</span><span class="p">:</span> <span class="s">"TTL:56h"</span><span class="p">,</span>
- <span class="s">"enteredTime"</span><span class="p">:</span> <span class="s">"2015-01-21 18:00:16"</span><span class="p">,</span>
- <span class="s">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"agent"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-21 10:45:38"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span>
+ <span class="s2">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"assetType"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"PENDING"</span><span class="p">,</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"dsXmlId"</span><span class="p">:</span> <span class="s2">"ds-xml-id"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"peewee"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:56h"</span><span class="p">,</span>
+ <span class="s2">"enteredTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 18:00:16"</span><span class="p">,</span>
+ <span class="s2">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"agent"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 10:45:38"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -771,11 +944,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
- <span class="s">"regex"</span><span class="p">:</span> <span class="s">"/path/to/content.jpg"</span><span class="p">,</span>
- <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-27 11:08:37"</span><span class="p">,</span>
- <span class="s">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"regex"</span><span class="p">:</span> <span class="s2">"/path/to/content.jpg"</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-27 11:08:37"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -817,12 +990,12 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span>
+<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="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully created purge job for: ."</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">"Successfully created purge job for: ."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -862,9 +1035,9 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"u"</span><span class="p">:</span> <span class="s">"username"</span><span class="p">,</span>
- <span class="s">"p"</span><span class="p">:</span> <span class="s">"password"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"u"</span><span class="p">:</span> <span class="s2">"username"</span><span class="p">,</span>
+ <span class="s2">"p"</span><span class="p">:</span> <span class="s2">"password"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -906,11 +1079,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully logged in."</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">"Successfully logged in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -969,15 +1142,15 @@ unnecessary work.</td>
</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">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"90"</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"90"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img-secure"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"280"</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img-secure"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"280"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1013,8 +1186,8 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"t"</span><span class="p">:</span> <span class="s">"token-value"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"token-value"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1056,11 +1229,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"error"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Unauthorized, please log in."</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Unauthorized, please log in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1114,11 +1287,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"You are logged out."</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">"You are logged out."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1155,8 +1328,8 @@ password reset.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1204,11 +1377,11 @@ password reset.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully sent password reset to email 'email@email.com'"</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">"Successfully sent password reset to email 'email@email.com'"</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/1.7.0/development/traffic_ops_api/v12/asn.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v12/asn.html b/docs/1.7.0/development/traffic_ops_api/v12/asn.html
index 2833b99..b9b732d 100644
--- a/docs/1.7.0/development/traffic_ops_api/v12/asn.html
+++ b/docs/1.7.0/development/traffic_ops_api/v12/asn.html
@@ -190,7 +190,7 @@
<span id="to-api-v12-asn"></span><h1>ASN<a class="headerlink" href="#asn" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-asns">
<span id="to-api-v12-asns-route"></span><h2>/api/1.2/asns<a class="headerlink" href="#api-1-2-asns" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/asns.json</strong></p>
+<p><strong>GET /api/1.2/asns</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,30 +208,44 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td colspan="3"><code class="docutils literal"><span class="pre">lastUpdated</span></code> | string | The Time / Date this server entry was last updated</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
</tr>
-<tr class="row-odd"><td colspan="3"><code class="docutils literal"><span class="pre">id</span></code> | string | Local unique identifier for the ASN</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the ASN</td>
</tr>
-<tr class="row-even"><td colspan="3"><code class="docutils literal"><span class="pre">asn</span></code> | string | Autonomous System Numbers per APNIC for identifying a service provider.</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">asn</span></code></td>
+<td>string</td>
+<td>Autonomous System Numbers per APNIC for identifying a service provider.</td>
</tr>
-<tr class="row-odd"><td colspan="3"><code class="docutils literal"><span class="pre">cachegroup</span></code> | string | Related cachegroup name</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>Related cachegroup name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>Related cachegroup id</td>
</tr>
</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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span>
- <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7015"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</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">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"28"</span><span class="p">,</span>
- <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7016"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-pa-pittsburgh"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -241,6 +255,206 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>GET /api/1.2/asns/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>ASN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="8%" />
+<col width="74%" />
+</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">lastUpdated</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">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the ASN</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">asn</span></code></td>
+<td>string</td>
+<td>Autonomous System Numbers per APNIC for identifying a service provider.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>Related cachegroup name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>Related cachegroup id</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">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</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>PUT /api/1.2/asns/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to edit an ASN.</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>ASN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</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">asn</span></code></td>
+<td>string</td>
+<td>ASN</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cachegroup the ASN belongs to</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">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</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">response</span></code></td>
+<td>hash</td>
+<td>The details of the update, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>id</span></code></td>
+<td>int</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>dnssecEnabled</span></code></td>
+<td>string</td>
+<td>Whether dnssec is enabled.</td>
+</tr>
+<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>
+</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="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</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">"cdn was updated."</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>
</div>
</div>
[20/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/division.txt b/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
index 2110b00..2d9403a 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
@@ -22,7 +22,141 @@ Divisions
.. _to-api-v12-division-route:
/api/1.2/divisions
-++++++++++++++++++
+++++++++++++++++
+
+**GET /api/1.2/divisions**
+ Get all divisions.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "West",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/divisions/:id**
+ Get division by Id.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**PUT /api/1.2/divisions/:id**
+ Update a division
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Division id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-----------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+==========================+
+ | ``name`` | yes | The name of the division |
+ +-----------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "mydivision1"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Division update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "mydivision1"
+ }
+ }
+|
+
**POST /api/1.2/divisions**
Create division
@@ -38,7 +172,7 @@ Divisions
+===========+==========+==========================+
| ``name`` | yes | The name of the division |
+-----------+----------+--------------------------+
-
+
**Request Example** ::
{
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt b/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt
index 818205c..81c00c3 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt
@@ -24,7 +24,7 @@ Parameter
/api/1.2/parameters
+++++++++++++++++++
-**GET /api/1.2/parameters.json**
+**GET /api/1.2/parameters**
Authentication Required: Yes
@@ -52,21 +52,21 @@ Parameter
"response": [
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": false,
"value": "foo.bar.net",
"name": "domain_name",
"config_file": "FooConfig.xml"
},
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": false,
"value": "0,1,2,3,4,5,6",
"name": "Drive_Letters",
"config_file": "storage.config"
},
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": true,
"value": "STRING __HOSTNAME__",
"name": "CONFIG proxy.config.proxy_name",
"config_file": "records.config"
@@ -76,7 +76,46 @@ Parameter
|
-**GET /api/1.2/parameters/profile/:name.json**
+**GET /api/1.2/parameters/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: if secure of the parameter fetched is 1, require admin role, or any valid role can access.
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "id": "27",
+ "config_file": "FooConfig.xml",
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/profiles/:id/parameters**
Authentication Required: Yes
@@ -84,11 +123,11 @@ Parameter
**Request Route Parameters**
- +------------------+----------+-------------+
- | Name | Required | Description |
- +==================+==========+=============+
- | ``profile_name`` | yes | |
- +------------------+----------+-------------+
+ +------------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==================+==========+=======================+
+ | ``id`` | yes | Profile id |
+ +------------------+----------+-----------------------+
**Response Properties**
@@ -112,21 +151,21 @@ Parameter
"response": [
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": false,
"value": "foo.bar.net",
"name": "domain_name",
"config_file": "FooConfig.xml"
},
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": false,
"value": "0,1,2,3,4,5,6",
"name": "Drive_Letters",
"config_file": "storage.config"
},
{
"last_updated": "2012-09-17 21:41:22",
- "secure": 0,
+ "secure": true,
"value": "STRING __HOSTNAME__",
"name": "CONFIG proxy.config.proxy_name",
"config_file": "records.config"
@@ -135,3 +174,344 @@ Parameter
}
|
+
+**GET /api/1.2/profiles/name/:name/parameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==================+==========+=======================+
+ | ``name`` | yes | Profile name |
+ +------------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": true,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/parameters**
+ Create parameters.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+ The request route parameters accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ parameters array format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+=========+======================================================================================+
+ | | array | parameters array |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>id`` | integer | The parameter id |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | string | parameter name |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | string | parameter config_file |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | string | parameter value |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+
+
+ **Request Example** ::
+
+ 1. single parameter format exampe:
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":0,
+ }
+
+ 2. array format example:
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":1,
+ }
+ ]
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "value":"value1",
+ "secure":0,
+ "name":"param1",
+ "id":"1139",
+ "configFile":"configFile1"
+ },
+ {
+ "value":"value2",
+ "secure":1,
+ "name":"param2",
+ "id":"1140",
+ "configFile":"configFile2"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/parameters/{:id}**
+ Edit parameter.
+
+ Authentication Required: Yes
+
+ 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.
+
+ **Request Parameters**
+
+ +-----------+---------+------------------+
+ | Parameter | Type | Description |
+ +===========+=========+==================+
+ | ``id`` | integer | The parameter id |
+ +-----------+---------+------------------+
+
+ **Request Route Parameters**
+
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+=========+======================================================================================+
+ | ``name`` | no | string | parameter name |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | no | string | parameter config_file |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | no | string | parameter value |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | no | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter id |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ }
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "value":"value1",
+ "secure":"0",
+ "name":"param1",
+ "id":"1134",
+ "configFile":"configFile1"
+ }
+ }
+
+|
+
+**DELETE /api/1.2/parameters/{:id}**
+ delete parameter. If the parameter have profile associated, can not be deleted.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper role
+
+ **Request Parameters**
+
+ +-----------+---------+------------------+
+ | Parameter | Type | Description |
+ +===========+=========+==================+
+ | ``id`` | integer | The parameter id |
+ +-----------+---------+------------------+
+
+ **No Request Route Parameters**
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ Response Example:
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Parameter was successfully deleted."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/parameters/validate**
+ Validate if the parameter exists.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+--------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+================================+
+ | ``name`` | yes | string | parameter name |
+ +----------------+----------+--------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +----------------+----------+--------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +----------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter id |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ }
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "value":"value1",
+ "secure":"0",
+ "name":"param1",
+ "id":"1134",
+ "configFile":"configFile1"
+ }
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt
index ef05085..53c561f 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt
@@ -24,7 +24,7 @@ Physical Location
/api/1.2/phys_locations
+++++++++++++++++++++++
-**GET /api/1.2/phys_locations.json**
+**GET /api/1.2/phys_locations**
Authentication Required: Yes
@@ -35,30 +35,34 @@ Physical Location
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``region`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``poc`` | string | |
+ |``address`` | string | |
+----------------------+--------+------------------------------------------------+
- |``name`` | string | |
+ |``city`` | string | |
+----------------------+--------+------------------------------------------------+
|``comments`` | string | |
+----------------------+--------+------------------------------------------------+
- |``phone`` | string | |
+ |``email`` | string | |
+----------------------+--------+------------------------------------------------+
- |``state`` | string | |
+ |``id`` | string | |
+----------------------+--------+------------------------------------------------+
- |``email`` | string | |
+ |``lastUpdated`` | string | |
+----------------------+--------+------------------------------------------------+
- |``city`` | string | |
+ |``name`` | string | |
+----------------------+--------+------------------------------------------------+
- |``zip`` | string | |
+ |``phone`` | string | |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
+ |``poc`` | string | |
+----------------------+--------+------------------------------------------------+
- |``address`` | string | |
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+----------------------+--------+------------------------------------------------+
|``shortName`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
@@ -66,7 +70,9 @@ Physical Location
"response": [
{
"region": "Mile High",
+ "region": "4",
"poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
"name": "Albuquerque",
"comments": "Albuquerque",
"phone": "(123) 555-1111",
@@ -79,20 +85,22 @@ Physical Location
"shortName": "Albuquerque"
},
{
- "region": "Chicago",
- "poc": "John Doe",
- "name": "Chicago",
- "comments": "",
- "phone": "(321) 555-1111",
- "state": "IL",
- "email": "john.doe@email.com",
- "city": "Chicago",
- "zip": "60636",
- "id": "3",
- "address": "123 East 4th Street",
- "shortName": "chicago"
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
}
- ],
+ ]
}
|
@@ -126,6 +134,209 @@ Physical Location
|
+
+**GET /api/1.2/phys_locations/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Physical location ID. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/phys_locations/:id**
+ Update a physical location
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Physical location id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+================================================+
+ | ``address`` | yes | Physical location address. |
+ +-------------------+----------+------------------------------------------------+
+ | ``city`` | yes | Physical location city. |
+ +-------------------+----------+------------------------------------------------+
+ | ``comments`` | no | Physical location comments. |
+ +-------------------+----------+------------------------------------------------+
+ | ``email`` | no | Physical location email. |
+ +-------------------+----------+------------------------------------------------+
+ | ``name`` | yes | Physical location name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``phone`` | no | Physical location phone. |
+ +-------------------+----------+------------------------------------------------+
+ | ``poc`` | no | Physical location point of contact. |
+ +-------------------+----------+------------------------------------------------+
+ | ``regionId`` | no | Physical location region ID. |
+ +-------------------+----------+------------------------------------------------+
+ | ``shortName`` | yes | Physical location short name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``state`` | yes | Physical location state. |
+ +-------------------+----------+------------------------------------------------+
+ | ``zip`` | yes | Physical location zip. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "regionId": "1",
+ "poc": "Jane Doesssss",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "address": "123 East 9rd St",
+ "shortName": "Albuquerque"
+ }
+
+|
+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Physical location update was successful."
+ }
+ ],
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+
**POST /api/1.2/regions/:region_name/phys_locations**
Create physical location.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt b/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt
index 82cb5ae..5892272 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt
@@ -25,12 +25,20 @@ Profiles
/api/1.2/profiles
+++++++++++++++++
-**GET /api/1.2/profiles.json**
+**GET /api/1.2/profiles**
Authentication Required: Yes
Role(s) Required: None
+ **Request Query Parameters**
+
+ +---------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+====================================================+
+ | ``param`` | no | Used to filter profiles by parameter. |
+ +---------------+----------+----------------------------------------------------+
+
**Response Properties**
+-----------------+--------+----------------------------------------------------+
@@ -60,7 +68,7 @@ Profiles
|
-**GET /api/1.2/profiles/trimmed.json**
+**GET /api/1.2/profiles/trimmed**
Authentication Required: Yes
@@ -86,6 +94,50 @@ Profiles
|
+**GET /api/1.2/profiles/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+------------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+============+================================================+
+ | ``id`` | yes | The ID of the profile. |
+ +-----------------+------------+------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
+
**POST /api/1.2/profiles**
Create a new empty profile.
@@ -187,3 +239,120 @@ Profiles
}
|
+
+**PUT /api/1.2/profiles/{:id}**
+
+ Allows user to edit a profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | profile id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Properties**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | yes | The new name for the profile. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``description`` | yes | The new description for the profile. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "CCR_UPDATE",
+ "description": "CCR_UPDATE description"
+ }
+
+ **Response Properties**
+
+ +------------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+==================================+
+ | ``response`` | | The updated profile info. |
+ +------------------+--------+----------------------------------+
+ | ``>id`` | string | Profile id. |
+ +------------------+--------+----------------------------------+
+ | ``>name`` | string | Profile name. |
+ +------------------+--------+----------------------------------+
+ | ``>description`` | string | Profile description. |
+ +------------------+--------+----------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+--------+----------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +------------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": "219",
+ "name": "CCR_UPDATE",
+ "description": "CCR_UPDATE description"
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile was updated: 219"
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/profiles/{:id}**
+
+ Allows user to delete a profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+----------------------------+
+ | Name | Required | Description |
+ +=================+==========+============================+
+ | ``id`` | yes | profile id. |
+ +-----------------+----------+----------------------------+
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Profile was deleted."
+ }
+ ]
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt b/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt
new file mode 100644
index 0000000..bc16128
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt
@@ -0,0 +1,458 @@
+..
+.. Copyright 2015 Comcast Cable Communications Management, LLC
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-profileparameters:
+
+
+Profile parameters
+==================
+
+.. _to-api-v12-profileparameters-route:
+
+/api/1.2/profileparameters
+++++++++++++++++++++++++++
+
+**POST /api/1.2/profileparameters**
+
+ Associate parameter to profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+ This accept two formats: single profile-parameter, profile-parameter array.
+
+ Single profile-parameter format:
+
+ +------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +==================+==========+====================================================+
+ | ``profileId`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameterId`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ Profile-parameter array format:
+
+ +------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +==================+==========+====================================================+
+ | | yes | profile-parameter array. |
+ +------------------+----------+----------------------------------------------------+
+ | ``>profileId`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``>parameterId`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ Single profile-parameter format:
+
+ {
+ "profileId": 2,
+ "parameterId": 6
+ }
+
+ Profile-parameter array format:
+
+ [
+ {
+ "profileId": 2,
+ "parameterId": 6
+ },
+ {
+ "profileId": 2,
+ "parameterId": 7
+ },
+ {
+ "profileId": 3,
+ "parameterId": 6
+ }
+ ]
+
+ **Response Properties**
+
+ +-------------------+---------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+=========+=====================================================+
+ | ``response`` | array | Profile-parameter associations. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>profileId`` | string | Profile id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>parameterId`` | string | Parameter id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+---------+-----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":[
+ {
+ "profileId": "2",
+ "parameterId": "6"
+ },
+ {
+ "profileId": "2",
+ "parameterId": "7"
+ },
+ {
+ "profileId": "3",
+ "parameterId": "6"
+ }
+ ]
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile parameter associations were created."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/profileparameters/{:profile_id}/{:parameter_id}**
+
+ Delete a profile parameter association.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+====================================================+
+ | ``profile_id`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameter_id`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=====================================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+--------+-----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile parameter association was deleted."
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/name/{:name}/parameters**
+
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+ If the profile does not exist, the API returns fail.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+
+ **Request Route Parameters**
+
+ +------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +============+==========+====================================================+
+ | ``name`` | yes | profile name. |
+ +------------+----------+----------------------------------------------------+
+
+ **Request Properties**
+ The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ array parameters format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ 1. single parameter format exampe:
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ }
+
+ 2. array format example:
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1,
+ }
+ ]
+
+
+ **Response Properties** ::
+
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | Name | Type | Description |
+ +==================+=========+======================================================================================+
+ | ``response`` | | Parameters associated with the profile. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileName`` | string | profile name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileId`` | integer | profile index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>parameters`` | array | parameters array |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>id`` | integer | parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>name`` | string | parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>configFile`` | string | parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>value`` | string | parameter value |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``version`` | string | |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/id/{:id}/parameters**
+
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+ If the profile does not exist, the API returns fail.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+
+ **Request Route Parameters**
+
+ +------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +============+==========+====================================================+
+ | ``id`` | yes | profile name. |
+ +------------+----------+----------------------------------------------------+
+
+ **Request Properties**
+ The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ array parameters format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ 1. single parameter format exampe:
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ }
+
+ 2. array format example:
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1,
+ }
+ ]
+
+
+ **Response Properties** ::
+
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | Name | Type | Description |
+ +==================+=========+======================================================================================+
+ | ``response`` | | Parameters associated with the profile. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileName`` | string | profile name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileId`` | integer | profile index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>parameters`` | array | parameters array |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>id`` | integer | parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>name`` | string | parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>configFile`` | string | parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>value`` | string | parameter value |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``version`` | string | |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/region.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/region.txt b/docs/latest/_sources/development/traffic_ops_api/v12/region.txt
index fc1e927..8129854 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/region.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/region.txt
@@ -24,7 +24,7 @@ Regions
/api/1.2/regions
++++++++++++++++
-**GET /api/1.2/regions.json**
+**GET /api/1.1/regions**
Authentication Required: Yes
@@ -35,9 +35,13 @@ Regions
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``name`` | string | |
+ |``id`` | string | Region ID. |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+----------------------+--------+------------------------------------------------+
**Response Example** ::
@@ -45,18 +49,132 @@ Regions
{
"response": [
{
+ "id": "6",
"name": "Atlanta",
- "id": "6"
+ "division": "2",
+ "divisionName": "West"
},
{
- "name": "Beltway",
- "id": "1"
+ "id": "7",
+ "name": "Denver",
+ "division": "2",
+ "divisionName": "West"
+ },
+ ]
+ }
+
+
+**GET /api/1.1/regions/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Region id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
}
- ],
+ ]
+ }
+
+
+**PUT /api/1.2/regions/:id**
+ Update a region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Region id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +================+==========+==========================+
+ | ``name`` | yes | The name of the region |
+ +----------------+----------+--------------------------+
+ | ``division`` | yes | The division Id |
+ +----------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ "division": "4"
}
|
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``division`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Region update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "myregion1",
+ "division": "4",
+ "divisionName": "mydivision1"
+ }
+ }
+|
+
**POST /api/1.2/divisions/:division_name/regions**
Create Region
[37/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/server.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/server.html b/docs/1.7.0/development/traffic_ops_api/v11/server.html
index 417b39e..5e6cb9e 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/server.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/server.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-server"></span><h1>Server<a class="headerlink" href="#server" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-servers">
<span id="to-api-v11-servers-route"></span><h2>/api/1.1/servers<a class="headerlink" href="#api-1-1-servers" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/servers.json</strong></p>
+<p><strong>GET /api/1.1/servers</strong></p>
<blockquote>
<div><p>Retrieves properties of CDN servers.</p>
<p>Authentication Required: Yes</p>
@@ -198,9 +198,9 @@
<p><strong>Request Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="17%" />
-<col width="15%" />
-<col width="68%" />
+<col width="27%" />
+<col width="13%" />
+<col width="60%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
@@ -213,6 +213,14 @@
<td>no</td>
<td>Used to filter servers by delivery service.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>no</td>
+<td>Used to filter servers by status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>no</td>
+<td>Used to filter servers by type.</td>
+</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
@@ -231,168 +239,467 @@
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><em>Cache Group</em></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
<td>The domain name part of the FQDN of the cache.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
<td>The host name part of the cache.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The server id (database row number).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the lights-out-management port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway address of the lights-out-management port.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the lights-out-management port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
<td>string</td>
<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
<td>string</td>
<td>The user name for lights-out-management.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
<td>string</td>
<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
<td>string</td>
<td>The network interface name used for serving traffic.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
<td>string</td>
<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
<td>string</td>
<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
<td>string</td>
<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>The Time and Date for the last update for this server.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
<td>string</td>
<td>The IPv4 address of the management port (optional).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
<td>string</td>
<td>The IPv4 gateway of the management port (optional).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
<td>string</td>
<td>The IPv4 netmask of the management port (optional).</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
+<td>The physical location id (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
<td>A string indicating rack location.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
<td>string</td>
<td>The human readable name of the router.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
<td>string</td>
<td>The human readable name of the router port.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><em>Status</em></a>).</td>
+<td>The Status id (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
+<td>bool</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">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</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.1/servers/:id</strong></p>
+<blockquote>
+<div><p>Retrieves properties of a CDN server by server ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Server id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</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">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
<td>string</td>
<td>The HTTPS port on which the main application listens (443 in most cases).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
+<td>The server id (database row number).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
<td>string</td>
-<td>Deprecated.</td>
+<td>The IPv4 address of the lights-out-management port.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmppPasswd</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
<td>string</td>
-<td>Deprecated.</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
</tr>
</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">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
- <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
- <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
- <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
- <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
- <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
- <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
- <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-03-08 15:57:32"</span><span class="p">,</span>
- <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
- <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
- <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
- <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
- <span class="s">"xmppId"</span><span class="p">:</span> <span class="s">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
- <span class="s">"xmppPasswd"</span><span class="p">:</span> <span class="s">"**********"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -402,7 +709,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/servers/summary.json</strong></p>
+<p><strong>GET /api/1.1/servers/summary</strong></p>
<blockquote>
<div><p>Retrieves a count of CDN servers by type.</p>
<p>Authentication Required: Yes</p>
@@ -427,41 +734,41 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
+<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- "count": 4,
- "type": "CCR"
- },
- {
- "count": 55,
- "type": "EDGE"
- },
- {
- "type": "MID",
- "count": 18
- },
- {
- "count": 0,
- "type": "INFLUXDB"
- },
- {
- "count": 4,
- "type": "RASCAL"
- }
-}
+<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">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CCR"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">55</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"MID"</span><span class="p">,</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">18</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"INFLUXDB"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"RASCAL"</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.1/servers/hostname/:name/details.json</strong></p>
+<p><strong>GET /api/1.1/servers/hostname/:name/details</strong></p>
<blockquote>
<div><p>Retrieves the details of a server.</p>
<p>Authentication Required: Yes</p>
@@ -502,11 +809,11 @@
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><em>Cache Group</em></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryservices</span></code></td>
<td>array</td>
-<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v11-ds"><em>Delivery Service</em></a>).</td>
+<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v11-ds"><span class="std std-ref">Delivery Service</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
@@ -514,7 +821,7 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">hardwareInfo</span></code></td>
<td>hash</td>
-<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v11-hwinfo"><em>Hardware Info</em></a>).</td>
+<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v11-hwinfo"><span class="std std-ref">Hardware Info</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
@@ -590,11 +897,11 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
@@ -610,7 +917,7 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><em>Status</em></a>).</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
@@ -622,7 +929,7 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td>
<td>string</td>
@@ -635,93 +942,93 @@
</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">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"3"</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="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"4"</span>
<span class="p">],</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s">"YS08"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Model"</span><span class="p">:</span> <span class="s">"PowerEdge R720xd"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s">"4217A5"</span><span class="p">,</span>
- <span class="s">"Lifecycle Controller"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Manufacturer"</span><span class="p">:</span> <span class="s">"Dell Inc."</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"SysMemTotalSize"</span><span class="p">:</span> <span class="s">"196608"</span><span class="p">,</span>
- <span class="s">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s">"24"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s">"13.5.7"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s">"1.00"</span><span class="p">,</span>
- <span class="s">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s">"7.0.0.29"</span><span class="p">,</span>
- <span class="s">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s">"1.57.57"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"ServiceTag"</span><span class="p">:</span> <span class="s">"D6XPDV1"</span><span class="p">,</span>
- <span class="s">"PowerState"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s">"D903"</span><span class="p">,</span>
- <span class="s">"BIOS"</span><span class="p">:</span> <span class="s">"1.3.6"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"System CPLD"</span><span class="p">:</span> <span class="s">"1.0.3"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span>
- <span class="s">"PERC H710P Mini"</span><span class="p">:</span> <span class="s">"21.0.2-0001"</span><span class="p">,</span>
- <span class="s">"PowerCap"</span><span class="p">:</span> <span class="s">"689"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span>
- <span class="s">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s">"1.07"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s">"7.2.20"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
- <span class="s">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s">"D1S2"</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s2">"YS08"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Model"</span><span class="p">:</span> <span class="s2">"PowerEdge R720xd"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s2">"4217A5"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Manufacturer"</span><span class="p">:</span> <span class="s2">"Dell Inc."</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"SysMemTotalSize"</span><span class="p">:</span> <span class="s2">"196608"</span><span class="p">,</span>
+ <span class="s2">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s2">"24"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s2">"13.5.7"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s2">"1.00"</span><span class="p">,</span>
+ <span class="s2">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s2">"7.0.0.29"</span><span class="p">,</span>
+ <span class="s2">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s2">"1.57.57"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"ServiceTag"</span><span class="p">:</span> <span class="s2">"D6XPDV1"</span><span class="p">,</span>
+ <span class="s2">"PowerState"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s2">"D903"</span><span class="p">,</span>
+ <span class="s2">"BIOS"</span><span class="p">:</span> <span class="s2">"1.3.6"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"System CPLD"</span><span class="p">:</span> <span class="s2">"1.0.3"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"PERC H710P Mini"</span><span class="p">:</span> <span class="s2">"21.0.2-0001"</span><span class="p">,</span>
+ <span class="s2">"PowerCap"</span><span class="p">:</span> <span class="s2">"689"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s2">"1.07"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s2">"7.2.20"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s2">"D1S2"</span>
<span class="p">},</span>
- <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
- <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
- <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
- <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
- <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
- <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
- <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
- <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
- <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
- <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
- <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
- <span class="s">"xmppId"</span><span class="p">:</span> <span class="s">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
- <span class="s">"xmppPasswd"</span><span class="p">:</span> <span class="s">"X"</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"xmppId"</span><span class="p">:</span> <span class="s2">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
+ <span class="s2">"xmppPasswd"</span><span class="p">:</span> <span class="s2">"X"</span>
<span class="p">}</span>
<span class="p">}</span>
@@ -769,11 +1076,11 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"host_name"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"servercheck_short_name"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"value"</span><span class="p">:</span> <span class="s">""</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"host_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -815,17 +1122,17 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>Response Example:
-
-{
- "alerts":
- [
- {
- "level": "success",
- "text": "Server Check was successfully updated."
- }
- ],
-}
+<div class="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">"Server Check was successfully updated."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/static_dns.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/static_dns.html b/docs/1.7.0/development/traffic_ops_api/v11/static_dns.html
index 32a65b3..418b03d 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/static_dns.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/static_dns.html
@@ -235,18 +235,18 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "deliveryservice": "foo-ds",
- "ttl": "30",
- "type": "CNAME_RECORD",
- "address": "bar.foo.baz.tv.",
- "cachegroup": "us-co-denver",
- "host": "mm"
- }
- ]
-}
+<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">"deliveryservice"</span><span class="p">:</span> <span class="s2">"foo-ds"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CNAME_RECORD"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"bar.foo.baz.tv."</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span><span class="p">,</span>
+ <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"mm"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/status.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/status.html b/docs/1.7.0/development/traffic_ops_api/v11/status.html
index 6d05ea2..bdc5dbf 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/status.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/status.html
@@ -190,9 +190,9 @@
<span id="to-api-v11-status"></span><h1>Status<a class="headerlink" href="#status" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-statuses">
<span id="to-api-v11-statuses-route"></span><h2>/api/1.1/statuses<a class="headerlink" href="#api-1-1-statuses" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/statuses.json</strong></p>
+<p><strong>GET /api/1.1/statuses</strong></p>
<blockquote>
-<div><p>Retrieves a list of the server status codes available. May be useful when the status is retrieved from other APIs as a number and not a string.</p>
+<div><p>Retrieves a list of the server status codes available.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
@@ -209,59 +209,130 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
-<td>The Time / Date this server entry was last updated</td>
+<td>The id with which Traffic Ops stores this status, and references it internally</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td>The string equivalent of the status</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>A short description of the status</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</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">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_IGNORE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</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">"name"</span><span class="p">:</span> <span class="s2">"OFFLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</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="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"REPORTED"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/statuses/:id</strong></p>
+<blockquote>
+<div><p>Retrieves a server status by ID.</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Status id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="8%" />
+<col width="76%" />
+</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>The id with which Traffic Ops stores this status, and references it internally</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The string equivalent of the status</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
<td>string</td>
<td>A short description of the status</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": [
- {
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
- "id": "4",
- "name": "ADMIN_DOWN",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "CCR_IGNORE",
- "id": "5",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"
- },
- {
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
- "id": "1",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "OFFLINE"
- },
- {
- "id": "2",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "ONLINE"
- },
- {
- "id": "3",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
- "name": "REPORTED",
- "lastUpdated": "2013-02-13 16:34:29"
- }
- ],
-}
+<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">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
[51/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
updates website files except for downloads dir
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/commit/91716725
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/91716725
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/91716725
Branch: refs/heads/asf-site
Commit: 91716725350ee8ad6edf196b035dd8e94dc3e923
Parents: 5a61ef5
Author: Jeremy Mitchell <je...@cable.comcast.com>
Authored: Tue Nov 1 15:43:25 2016 -0600
Committer: Jeremy Mitchell <je...@cable.comcast.com>
Committed: Tue Nov 1 15:43:25 2016 -0600
----------------------------------------------------------------------
.../_sources/admin/quick_howto/multi_site.txt | 6 +-
docs/1.7.0/_sources/admin/traffic_router.txt | 106 ++
docs/1.7.0/_sources/admin/traffic_stats.txt | 19 +-
docs/1.7.0/_sources/development/traffic_ops.txt | 3 +-
.../development/traffic_ops_api/v11/asn.txt | 2 +-
.../traffic_ops_api/v11/cachegroup.txt | 150 +-
.../development/traffic_ops_api/v11/cdn.txt | 131 +-
.../traffic_ops_api/v11/deliveryservice.txt | 536 +++++---
.../traffic_ops_api/v11/phys_location.txt | 375 ++++-
.../development/traffic_ops_api/v11/profile.txt | 48 +-
.../development/traffic_ops_api/v11/region.txt | 193 ++-
.../development/traffic_ops_api/v11/server.txt | 211 ++-
.../development/traffic_ops_api/v11/status.txt | 75 +-
.../development/traffic_ops_api/v11/type.txt | 78 +-
.../development/traffic_ops_api/v11/user.txt | 177 ++-
.../development/traffic_ops_api/v12/asn.txt | 140 +-
.../traffic_ops_api/v12/cachegroup.txt | 154 ++-
.../development/traffic_ops_api/v12/cdn.txt | 133 +-
.../traffic_ops_api/v12/deliveryservice.txt | 599 ++++----
.../traffic_ops_api/v12/division.txt | 138 +-
.../traffic_ops_api/v12/parameter.txt | 406 +++++-
.../traffic_ops_api/v12/phys_location.txt | 261 +++-
.../development/traffic_ops_api/v12/profile.txt | 173 ++-
.../traffic_ops_api/v12/profile_parameter.txt | 458 ++++++
.../development/traffic_ops_api/v12/region.txt | 132 +-
.../development/traffic_ops_api/v12/server.txt | 225 ++-
.../development/traffic_ops_api/v12/status.txt | 75 +-
.../development/traffic_ops_api/v12/type.txt | 80 +-
.../development/traffic_ops_api/v12/user.txt | 238 +++-
.../_sources/development/traffic_stats.txt | 22 +-
docs/1.7.0/_sources/overview/traffic_stats.txt | 14 +-
docs/1.7.0/_static/basic.css | 15 +-
docs/1.7.0/_static/doctools.js | 28 +-
docs/1.7.0/_static/pygments.css | 2 +
docs/1.7.0/_static/searchtools.js | 51 +-
docs/1.7.0/_static/websupport.js | 4 +-
docs/1.7.0/admin/index.html | 11 +-
docs/1.7.0/admin/quick_howto/dnssec.html | 8 +-
docs/1.7.0/admin/quick_howto/federations.html | 14 +-
docs/1.7.0/admin/quick_howto/index.html | 2 +-
docs/1.7.0/admin/quick_howto/multi_site.html | 24 +-
docs/1.7.0/admin/quick_howto/regionalgeo.html | 50 +-
docs/1.7.0/admin/quick_howto/steering.html | 38 +-
docs/1.7.0/admin/traffic_monitor.html | 18 +-
docs/1.7.0/admin/traffic_ops_config.html | 20 +-
docs/1.7.0/admin/traffic_ops_extensions.html | 68 +-
docs/1.7.0/admin/traffic_ops_install.html | 178 +--
docs/1.7.0/admin/traffic_ops_using.html | 126 +-
docs/1.7.0/admin/traffic_portal.html | 2 +-
docs/1.7.0/admin/traffic_router.html | 153 ++-
docs/1.7.0/admin/traffic_server.html | 8 +-
docs/1.7.0/admin/traffic_stats.html | 25 +-
docs/1.7.0/admin/traffic_vault.html | 2 +-
docs/1.7.0/basics/cache_revalidation.html | 70 +-
docs/1.7.0/basics/caching_proxies.html | 172 +--
.../1.7.0/basics/content_delivery_networks.html | 2 +-
docs/1.7.0/basics/http_11.html | 14 +-
docs/1.7.0/basics/index.html | 2 +-
docs/1.7.0/development/index.html | 2 +-
docs/1.7.0/development/traffic_monitor.html | 4 +-
docs/1.7.0/development/traffic_ops.html | 39 +-
.../development/traffic_ops_api/routes.html | 92 +-
.../development/traffic_ops_api/v11/asn.html | 24 +-
.../traffic_ops_api/v11/cachegroup.html | 269 ++--
.../development/traffic_ops_api/v11/cdn.html | 423 ++++--
.../traffic_ops_api/v11/changelog.html | 62 +-
.../traffic_ops_api/v11/deliveryservice.html | 917 +++++++------
.../development/traffic_ops_api/v11/hwinfo.html | 20 +-
.../traffic_ops_api/v11/parameter.html | 68 +-
.../traffic_ops_api/v11/phys_location.html | 630 ++++++++-
.../traffic_ops_api/v11/profile.html | 97 +-
.../development/traffic_ops_api/v11/region.html | 331 ++++-
.../development/traffic_ops_api/v11/role.html | 12 +-
.../development/traffic_ops_api/v11/server.html | 721 +++++++---
.../traffic_ops_api/v11/static_dns.html | 24 +-
.../development/traffic_ops_api/v11/status.html | 149 +-
.../development/traffic_ops_api/v11/system.html | 20 +-
.../traffic_ops_api/v11/to_extension.html | 94 +-
.../development/traffic_ops_api/v11/type.html | 140 +-
.../development/traffic_ops_api/v11/user.html | 435 ++++--
.../development/traffic_ops_api/v12/asn.html | 244 +++-
.../traffic_ops_api/v12/cache_stats.html | 48 +-
.../traffic_ops_api/v12/cachegroup.html | 425 +++---
.../development/traffic_ops_api/v12/cdn.html | 529 ++++---
.../traffic_ops_api/v12/changelog.html | 62 +-
.../traffic_ops_api/v12/deliveryservice.html | 1298 ++++++++++--------
.../v12/deliveryservice_stats.html | 66 +-
.../traffic_ops_api/v12/division.html | 234 +++-
.../traffic_ops_api/v12/federation.html | 60 +-
.../development/traffic_ops_api/v12/hwinfo.html | 20 +-
.../traffic_ops_api/v12/influxdb.html | 48 +-
.../traffic_ops_api/v12/parameter.html | 722 +++++++++-
.../traffic_ops_api/v12/phys_location.html | 483 ++++++-
.../traffic_ops_api/v12/profile.html | 329 ++++-
.../traffic_ops_api/v12/profile_parameter.html | 887 ++++++++++++
.../development/traffic_ops_api/v12/region.html | 245 +++-
.../development/traffic_ops_api/v12/role.html | 12 +-
.../development/traffic_ops_api/v12/server.html | 927 ++++++++-----
.../traffic_ops_api/v12/static_dns.html | 24 +-
.../development/traffic_ops_api/v12/status.html | 152 +-
.../development/traffic_ops_api/v12/system.html | 20 +-
.../traffic_ops_api/v12/to_extension.html | 94 +-
.../traffic_ops_api/v12/topology.html | 4 +-
.../development/traffic_ops_api/v12/type.html | 139 +-
.../development/traffic_ops_api/v12/user.html | 448 ++++--
docs/1.7.0/development/traffic_portal.html | 2 +-
docs/1.7.0/development/traffic_router.html | 4 +-
docs/1.7.0/development/traffic_server.html | 2 +-
docs/1.7.0/development/traffic_stats.html | 12 +-
docs/1.7.0/faq/administration.html | 2 +-
docs/1.7.0/faq/development.html | 2 +-
docs/1.7.0/faq/general.html | 2 +-
docs/1.7.0/faq/index.html | 2 +-
docs/1.7.0/genindex.html | 4 +-
docs/1.7.0/glossary.html | 40 +-
docs/1.7.0/index.html | 3 +-
docs/1.7.0/objects.inv | Bin 2615 -> 3713 bytes
docs/1.7.0/overview/index.html | 2 +-
docs/1.7.0/overview/introduction.html | 2 +-
docs/1.7.0/overview/traffic_monitor.html | 2 +-
docs/1.7.0/overview/traffic_ops.html | 2 +-
docs/1.7.0/overview/traffic_portal.html | 2 +-
docs/1.7.0/overview/traffic_router.html | 16 +-
docs/1.7.0/overview/traffic_server.html | 4 +-
docs/1.7.0/overview/traffic_stats.html | 4 +-
docs/1.7.0/overview/traffic_vault.html | 2 +-
docs/1.7.0/searchindex.js | 2 +-
.../_sources/admin/quick_howto/multi_site.txt | 6 +-
docs/latest/_sources/admin/traffic_router.txt | 106 ++
docs/latest/_sources/admin/traffic_stats.txt | 19 +-
.../latest/_sources/development/traffic_ops.txt | 3 +-
.../development/traffic_ops_api/v11/asn.txt | 2 +-
.../traffic_ops_api/v11/cachegroup.txt | 150 +-
.../development/traffic_ops_api/v11/cdn.txt | 131 +-
.../traffic_ops_api/v11/deliveryservice.txt | 536 +++++---
.../traffic_ops_api/v11/phys_location.txt | 375 ++++-
.../development/traffic_ops_api/v11/profile.txt | 48 +-
.../development/traffic_ops_api/v11/region.txt | 193 ++-
.../development/traffic_ops_api/v11/server.txt | 211 ++-
.../development/traffic_ops_api/v11/status.txt | 75 +-
.../development/traffic_ops_api/v11/type.txt | 78 +-
.../development/traffic_ops_api/v11/user.txt | 177 ++-
.../development/traffic_ops_api/v12/asn.txt | 140 +-
.../traffic_ops_api/v12/cachegroup.txt | 154 ++-
.../development/traffic_ops_api/v12/cdn.txt | 133 +-
.../traffic_ops_api/v12/deliveryservice.txt | 599 ++++----
.../traffic_ops_api/v12/division.txt | 138 +-
.../traffic_ops_api/v12/parameter.txt | 406 +++++-
.../traffic_ops_api/v12/phys_location.txt | 261 +++-
.../development/traffic_ops_api/v12/profile.txt | 173 ++-
.../traffic_ops_api/v12/profile_parameter.txt | 458 ++++++
.../development/traffic_ops_api/v12/region.txt | 132 +-
.../development/traffic_ops_api/v12/server.txt | 225 ++-
.../development/traffic_ops_api/v12/status.txt | 75 +-
.../development/traffic_ops_api/v12/type.txt | 80 +-
.../development/traffic_ops_api/v12/user.txt | 238 +++-
.../_sources/development/traffic_stats.txt | 22 +-
docs/latest/_sources/overview/traffic_stats.txt | 14 +-
docs/latest/_static/basic.css | 15 +-
docs/latest/_static/doctools.js | 28 +-
docs/latest/_static/pygments.css | 2 +
docs/latest/_static/searchtools.js | 51 +-
docs/latest/_static/websupport.js | 4 +-
docs/latest/admin/index.html | 11 +-
docs/latest/admin/quick_howto/dnssec.html | 8 +-
docs/latest/admin/quick_howto/federations.html | 14 +-
docs/latest/admin/quick_howto/index.html | 2 +-
docs/latest/admin/quick_howto/multi_site.html | 24 +-
docs/latest/admin/quick_howto/regionalgeo.html | 50 +-
docs/latest/admin/quick_howto/steering.html | 38 +-
docs/latest/admin/traffic_monitor.html | 18 +-
docs/latest/admin/traffic_ops_config.html | 20 +-
docs/latest/admin/traffic_ops_extensions.html | 68 +-
docs/latest/admin/traffic_ops_install.html | 178 +--
docs/latest/admin/traffic_ops_using.html | 126 +-
docs/latest/admin/traffic_portal.html | 2 +-
docs/latest/admin/traffic_router.html | 153 ++-
docs/latest/admin/traffic_server.html | 8 +-
docs/latest/admin/traffic_stats.html | 25 +-
docs/latest/admin/traffic_vault.html | 2 +-
docs/latest/basics/cache_revalidation.html | 70 +-
docs/latest/basics/caching_proxies.html | 172 +--
.../basics/content_delivery_networks.html | 2 +-
docs/latest/basics/http_11.html | 14 +-
docs/latest/basics/index.html | 2 +-
docs/latest/development/index.html | 2 +-
docs/latest/development/traffic_monitor.html | 4 +-
docs/latest/development/traffic_ops.html | 39 +-
.../development/traffic_ops_api/routes.html | 92 +-
.../development/traffic_ops_api/v11/asn.html | 24 +-
.../traffic_ops_api/v11/cachegroup.html | 269 ++--
.../development/traffic_ops_api/v11/cdn.html | 423 ++++--
.../traffic_ops_api/v11/changelog.html | 62 +-
.../traffic_ops_api/v11/deliveryservice.html | 917 +++++++------
.../development/traffic_ops_api/v11/hwinfo.html | 20 +-
.../traffic_ops_api/v11/parameter.html | 68 +-
.../traffic_ops_api/v11/phys_location.html | 630 ++++++++-
.../traffic_ops_api/v11/profile.html | 97 +-
.../development/traffic_ops_api/v11/region.html | 331 ++++-
.../development/traffic_ops_api/v11/role.html | 12 +-
.../development/traffic_ops_api/v11/server.html | 721 +++++++---
.../traffic_ops_api/v11/static_dns.html | 24 +-
.../development/traffic_ops_api/v11/status.html | 149 +-
.../development/traffic_ops_api/v11/system.html | 20 +-
.../traffic_ops_api/v11/to_extension.html | 94 +-
.../development/traffic_ops_api/v11/type.html | 140 +-
.../development/traffic_ops_api/v11/user.html | 435 ++++--
.../development/traffic_ops_api/v12/asn.html | 244 +++-
.../traffic_ops_api/v12/cache_stats.html | 48 +-
.../traffic_ops_api/v12/cachegroup.html | 425 +++---
.../development/traffic_ops_api/v12/cdn.html | 529 ++++---
.../traffic_ops_api/v12/changelog.html | 62 +-
.../traffic_ops_api/v12/deliveryservice.html | 1298 ++++++++++--------
.../v12/deliveryservice_stats.html | 66 +-
.../traffic_ops_api/v12/division.html | 234 +++-
.../traffic_ops_api/v12/federation.html | 60 +-
.../development/traffic_ops_api/v12/hwinfo.html | 20 +-
.../traffic_ops_api/v12/influxdb.html | 48 +-
.../traffic_ops_api/v12/parameter.html | 722 +++++++++-
.../traffic_ops_api/v12/phys_location.html | 483 ++++++-
.../traffic_ops_api/v12/profile.html | 329 ++++-
.../traffic_ops_api/v12/profile_parameter.html | 887 ++++++++++++
.../development/traffic_ops_api/v12/region.html | 245 +++-
.../development/traffic_ops_api/v12/role.html | 12 +-
.../development/traffic_ops_api/v12/server.html | 927 ++++++++-----
.../traffic_ops_api/v12/static_dns.html | 24 +-
.../development/traffic_ops_api/v12/status.html | 152 +-
.../development/traffic_ops_api/v12/system.html | 20 +-
.../traffic_ops_api/v12/to_extension.html | 94 +-
.../traffic_ops_api/v12/topology.html | 4 +-
.../development/traffic_ops_api/v12/type.html | 139 +-
.../development/traffic_ops_api/v12/user.html | 448 ++++--
docs/latest/development/traffic_portal.html | 2 +-
docs/latest/development/traffic_router.html | 4 +-
docs/latest/development/traffic_server.html | 2 +-
docs/latest/development/traffic_stats.html | 12 +-
docs/latest/faq/administration.html | 2 +-
docs/latest/faq/development.html | 2 +-
docs/latest/faq/general.html | 2 +-
docs/latest/faq/index.html | 2 +-
docs/latest/genindex.html | 4 +-
docs/latest/glossary.html | 40 +-
docs/latest/index.html | 3 +-
docs/latest/objects.inv | Bin 2615 -> 3713 bytes
docs/latest/overview/index.html | 2 +-
docs/latest/overview/introduction.html | 2 +-
docs/latest/overview/traffic_monitor.html | 2 +-
docs/latest/overview/traffic_ops.html | 2 +-
docs/latest/overview/traffic_portal.html | 2 +-
docs/latest/overview/traffic_router.html | 16 +-
docs/latest/overview/traffic_server.html | 4 +-
docs/latest/overview/traffic_stats.html | 4 +-
docs/latest/overview/traffic_vault.html | 2 +-
docs/latest/searchindex.js | 2 +-
images/traffic_portal_logo.png | Bin 0 -> 5421 bytes
index.html | 52 +-
traffic_monitor/index.html | 10 +-
traffic_ops/index.html | 11 +-
traffic_router/index.html | 10 +-
traffic_stats/index.html | 10 +-
260 files changed, 28142 insertions(+), 9293 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/admin/quick_howto/multi_site.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/admin/quick_howto/multi_site.txt b/docs/1.7.0/_sources/admin/quick_howto/multi_site.txt
index 514fd50..0811056 100644
--- a/docs/1.7.0/_sources/admin/quick_howto/multi_site.txt
+++ b/docs/1.7.0/_sources/admin/quick_howto/multi_site.txt
@@ -64,6 +64,10 @@ Configure Multi Site Origin
+------------------+--------------------------------------------------------------------------------------------------------------------+
| Primary/back | Round robin selection does not occur. The first origin server is selected unless it fails. |
| | If the first fails, the second and other following origin servers will be tried by order. |
+| | Order is defined by 2 factors - if the origin server's cachegroup is configured as the |
+| | parent cachegroup for the mid, then this server will be used as the primary. The same rules |
+| | apply for secondary parents, in order. Within the cachegroups, the rank parameter will sort |
+| | order further. If no parents are defined at the mid, then only rank is considered. |
+------------------+--------------------------------------------------------------------------------------------------------------------+
| Strict | MID caches serve requests strictly in turn. For example: origin server 1 serves the first request, |
| round-robin | origin server 2 serves the second request, and so on. |
@@ -72,7 +76,7 @@ Configure Multi Site Origin
| round-robin | |
+------------------+--------------------------------------------------------------------------------------------------------------------+
-7) Optionally, if "Primary/backup" is selected for "Multi Site Origin Algorithm", a new parameter \u201crank\u201d should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of "2" precedes OS with the rank of "5". For any OS, if rank value is not defined in its profile, its rank value will default to \u201c1\u201d.
+7) Optionally, there are two configuration options that can set the order of the origins used if "Primary/backup" is selected for "Multi Site Origin Algorithm". By creating location-based cachegroups and assigning the origin servers accordingly and defining these cachegroups as parents for specific mids, location-based primary/secondary selection can be made. If primary/secondary selection should be the same for all mids, then a new parameter \u201crank\u201d should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of "2" precedes OS with the rank of "5". For any OS, if rank value is not defined in its profile, its rank value will default to \u201c1\u201d. In the event that both location based cachegroups are used alongside rank, sorting will be by cachegroup first and rank second. In this way it is possible to have specific backup servers for use at specific locations.
.. image:: mso-rank.png
:scale: 60%
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/admin/traffic_router.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/admin/traffic_router.txt b/docs/1.7.0/_sources/admin/traffic_router.txt
index 774cfe9..8f274a7 100644
--- a/docs/1.7.0/_sources/admin/traffic_router.txt
+++ b/docs/1.7.0/_sources/admin/traffic_router.txt
@@ -17,6 +17,10 @@
*****************************
Traffic Router Administration
*****************************
+.. contents::
+ :depth: 2
+ :backlinks: top
+
Installing Traffic Router
==========================
The following are requirements to ensure an accurate set up:
@@ -387,3 +391,105 @@ The following needs to be completed for Steering to work correctly:
For more information see the `steering how-to guide <quick_howto/steering.html>`_.
+HTTPS for Http Type Delivery Services
+=====================================
+
+Starting with version 1.7 Traffic Router added the ability to allow https traffic between itself and clients on a per http type delivery service basis.
+
+.. Warning::
+ The establishing of an HTTPS connection is much more computationally demanding than an HTTP connection.
+ Since each client will in turn get redirected to ATS, Traffic Router is most always creating a new HTTPS connection for all HTTPS traffic.
+ It is likely to mean that an existing Traffic Router will have some decrease in performance depending on the amount of https traffic you want to support
+ As noted for DNSSEC, you may need to plan to scale Traffic Router vertically and/or horizontally to handle the new load
+
+The summary for setting up https is to:
+
+#. Select one of 'https', 'http and https', or 'http to https' for the delivery service
+#. Generate private keys for the delivery service using a wildcard domain such as ``*.my-delivery-service.my-cdn.example.com``
+#. Obtain and import signed certificate chain
+#. Snapshot CR Config
+
+Clients may make HTTPS requests delivery services only after Traffic Router receives the certificate chain from Traffic Ops and the new CR Config.
+
+Protocol Options
+----------------
+
+*https only*
+ Traffic Router will only redirect (send a 302) to clients communicating with a secure connection, all other clients will receive a 503
+*http and https*
+ Traffic Router will redirect both secure and non-secure clients
+*http to https*
+ Traffic Router will redirect non-secure clients with a 302 and a location that is secure (i.e. starting with 'https' instead of 'http'), secure clients will remain on https
+*http*
+ Any secure client will get an SSL handshake error. Non-secure clients will experience the same behavior as prior to 1.7
+
+Certificate Retrieval
+---------------------
+
+.. Warning::
+ If you have https delivery services in your CDN, Traffic Router will not accept **any** connections until it is able to
+ fetch certificates from Traffic Ops and load them into memory. Traffic Router does not persist certificates to the java keystore or anywhere else.
+
+Traffic Router fetches certificates into memory:
+
+* At startup time
+* When it receives a new CR Config
+* Once an hour from whenever the most recent of the last of the above occurred
+
+.. Note::
+ To adjust the frequency when Traffic Router fetches certificates add the parameter 'certificates.polling.interval' to CR Config and
+ setting it to the desired time in milliseconds.
+
+.. Note::
+ Taking a snapshot of CR Config may be used at times to avoid waiting the entire polling cycle for a new set of certificates.
+
+.. Warning::
+ If a snapshot of CR Config is made that involves a delivery service missing its certificates, Traffic Router will ignore **ALL** changes in that CR-Config
+ until one of the following occurs:
+ * It receives certificates for that delivery service
+ * Another snapshot of CR Config is created and the delivery service without certificates is changed so it's HTTP protocol is set to 'http'
+
+Certificate Chain Ordering
+--------------------------
+
+The ordering of certificates within the certificate bundle matters. It must be:
+
+#. Primary Certificate (e.g. the one created for ``*.my-delivery-service.my-cdn.example.com``)
+#. Intermediate Certificate(s)
+#. Root Certificate from CA (optional)
+
+.. Warning::
+ If something is wrong with the certificate chain (e.g. the order of the certificates is backwards or for the wrong domain) the
+ client will get an SSL handshake. Inspection of /opt/tomcat/logs/catalina.out is likely to yield information to reveal this.
+
+To see the ordering of certificates you may have to manually split up your certificate chain and use openssl on each individual certificate
+
+Suggested Way of Setting up an HTTPS Delivery Service
+-----------------------------------------------------
+
+Do the following in Traffic Ops:
+
+#. Select one of 'https', 'http and https', or 'http to https' for the protocol field of a delivery service and click 'Save'.
+#. Click 'Manage SSL Keys'.
+#. Click 'Generate New Keys'.
+#. Copy the contents of the Certificate Signing Request field and save it locally.
+#. Click 'Load Keys'.
+#. Select 'http' for the protocol field of the delivery service and click 'Save' (to avoid preventing other CR Config updates from being blocked by Traffic Router)
+#. Follow your standard procedure for obtaining your signed certificate chain from a CA.
+#. After receiving your certificate chain import it into Traffic Ops.
+#. Edit the delivery service.
+#. Restore your original choice for the protocol field and click save.
+#. Click 'Manage SSL Keys'.
+#. Click 'Paste Existing Keys'.
+#. Paste the certificate chain into the CRT field.
+#. Click 'Load Keys'.
+#. Take a new snapshot of CR Config.
+
+Once this is done you should be able to test you are getting correctly redirected by Traffic Router using curl commands to https destinations on your delivery service.
+
+A new testing tool was created for load testing traffic router, it allows you to generate requests from your local box to multiple delivery services of a single cdn.
+You can control which cdn, delivery services, how many transactions per delivery service, and how many concurrent requests.
+During the test it will provide feedback about request latency and transactions per second.
+
+While it is running it is suggested that you monitor your Traffic Router nodes for memory and CPU utilization.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/admin/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/admin/traffic_stats.txt b/docs/1.7.0/_sources/admin/traffic_stats.txt
index 9231fc7..e8d9e78 100644
--- a/docs/1.7.0/_sources/admin/traffic_stats.txt
+++ b/docs/1.7.0/_sources/admin/traffic_stats.txt
@@ -18,7 +18,7 @@
Traffic Stats Administration
****************************
-Traffic Stats actually consists of three seperate components: Traffic Stats, InfluxDB, and Grafana. See below for information on installing and configuring each component as well as configuring the integration between the three and Traffic Ops.
+Traffic Stats consists of three seperate components: Traffic Stats, InfluxDB, and Grafana. See below for information on installing and configuring each component as well as configuring the integration between the three and Traffic Ops.
Installation
========================
@@ -31,14 +31,14 @@ Installation
**Installing InfluxDB:**
- **As of Traffic Stats 1.4.0, InfluxDb 0.9.6 or higher is required. For InfluxDb versions less than 0.9.6 use Traffic Stats 1.3.0**
+ **As of Traffic Stats 1.8.0, InfluxDb 1.0.0 or higher is required. For InfluxDb versions less than 1.0.0 use Traffic Stats 1.7.x**
- In order to store traffic stats data you will need to install InfluxDB. It is recommended InfluxDB be installed in a 3 server cluster; VMs are acceptable. The documentation for installing InfluxDB can be found on the InfluxDB `website <https://docs.influxdata.com/influxdb/latest/introduction/installation/>`_.
+ In order to store traffic stats data you will need to install `InfluxDB <https://docs.influxdata.com/influxdb/latest/introduction/installation/>`_. While not required, it is recommended to use some sort of high availability option like `Influx enterprise <https://portal.influxdata.com/>`_, `Influxdb Relay <https://github.com/influxdata/influxdb-relay>`_, or another `high availability option <https://www.influxdata.com/high-availability/>`_.
**Installing Grafana:**
- Grafana is used to display Traffic Stats/InfluxDB data in Traffic Ops. Grafana is typically run on the same server as Traffic Stats but this is not a requirement. Grafana can be installed on any server that can access InfluxDB and be accessed by Traffic Ops. Documentation on installing Grafana can be found `here <http://docs.grafana.org/installation/>`_.
+ Grafana is used to display Traffic Stats/InfluxDB data in Traffic Ops. Grafana is typically run on the same server as Traffic Stats but this is not a requirement. Grafana can be installed on any server that can access InfluxDB and can be accessed by Traffic Ops. Documentation on installing Grafana can be found on the `Grafana website <http://docs.grafana.org/installation/>`_.
Configuration
=========================
@@ -53,25 +53,26 @@ Configuration
- *toUrl:* The URL of the Traffic Ops server used by Traffic Stats
- *influxUser:* The user to use when connecting to InfluxDB (if configured on InfluxDB, else leave default)
- *influxPassword:* That password to use when connecting to InfluxDB (if configured, else leave blank)
- - *polling interval:* The interval at which Traffic Monitor is polled and stats are stored in InfluxDB
+ - *pollingInterval:* The interval at which Traffic Monitor is polled and stats are stored in InfluxDB
- *statusToMon:* The status of Traffic Monitor to poll (poll ONLINE or OFFLINE traffic monitors)
- *seelogConfig:* The absolute path of the seelong config file
- *dailySummaryPollingInterval:* The interval, in seconds, at which Traffic Stats checks to see if daily stats need to be computed and stored.
- *cacheRetentionPolicy:* The default retention policy for cache stats
- *dsRetentionPolicy:* The default retention policy for deliveryservice stats
- *dailySummaryRetentionPolicy:* The retention policy to be used for the daily stats
+ - *influxUrls:* An array of influxdb hosts for Traffic Stats to write stats to.
**Configuring InfluxDB:**
- It is HIGHLY recommended that InfluxDB be configured for clustering. Documentation on clustering configuration can be found on the clustering page of the `InfluxDB Website <https://docs.influxdata.com/influxdb/latest/clustering/>`_.
+ As mentioned above, it is recommended that InfluxDb be running in some sort of high availability configuration. There are several ways to achieve high availabilty so it is best to consult the high availability options on the `InfuxDB website <https://www.influxdata.com/high-availability/>`_.
- Once InfluxDB is installed and clustering is configured, Databases and Retention Policies need to be created. Traffic Stats writes to three different databases: cache_stats, deliveryservice_stats, and daily_stats. More information about the databases and what data is stored in each can be found on the `overview <../overview/traffic_stats.html>`_ page.
+ Once InfluxDB is installed and configured, databases and retention policies need to be created. Traffic Stats writes to three different databases: cache_stats, deliveryservice_stats, and daily_stats. More information about the databases and what data is stored in each can be found on the `overview <../overview/traffic_stats.html>`_ page.
- To easily create databases, retention policies, and continuous queries, run create_ts_databases.go from the influxdb_tools directory. See the `InfluxDb Tools <traffic_stats.html#influxdb-tools>`_ section below for more information.
+ To easily create databases, retention policies, and continuous queries, run create_ts_databases from the /opt/traffic_stats/influxdb_tools directory on your Traffic Stats server. See the `InfluxDb Tools <traffic_stats.html#influxdb-tools>`_ section below for more information.
**Configuring Grafana:**
- In Traffic Ops the Health -> Graph View tab can be configured to display grafana graphs using influxDb data. In order for this to work correctly, you will need two things 1) a parameter added to traffic ops with the graph URL (we will discuss later) and 2) the graphs created in grafana. See below for how to create some simple graphs in grafana. These instructions assume that InfluxDB has been installed and conifugred and that data has been written to it. If this is not true, you will not see any graphs.
+ In Traffic Ops the Health -> Graph View tab can be configured to display grafana graphs using influxDb data. In order for this to work correctly, you will need two things 1) a parameter added to traffic ops with the graph URL (more information below) and 2) the graphs created in grafana. See below for how to create some simple graphs in grafana. These instructions assume that InfluxDB has been configured and that data has been written to it. If this is not true, you will not see any graphs.
- Login to grafana as an admin user http://grafana_url:3000/login
- Choose Data Sources and then Add New
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops.txt b/docs/1.7.0/_sources/development/traffic_ops.txt
index 520dc19..c2957a5 100644
--- a/docs/1.7.0/_sources/development/traffic_ops.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops.txt
@@ -606,13 +606,14 @@ API 1.2 Reference
traffic_ops_api/v12/changelog
traffic_ops_api/v12/deliveryservice
traffic_ops_api/v12/deliveryservice_stats
+ traffic_ops_api/v12/division
traffic_ops_api/v12/federation
traffic_ops_api/v12/hwinfo
traffic_ops_api/v12/parameter
traffic_ops_api/v12/phys_location
traffic_ops_api/v12/profile
+ traffic_ops_api/v12/profile_parameter
traffic_ops_api/v12/influxdb
- traffic_ops_api/v12/division
traffic_ops_api/v12/region
traffic_ops_api/v12/role
traffic_ops_api/v12/server
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v11/asn.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v11/asn.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v11/asn.txt
index 8ed5d5c..bd10bb7 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v11/asn.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v11/asn.txt
@@ -25,7 +25,7 @@ ASN
/api/1.1/asns
+++++++++++++
-**GET /api/1.1/asns.json**
+**GET /api/1.1/asns**
Authentication Required: Yes
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v11/cachegroup.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v11/cachegroup.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v11/cachegroup.txt
index d0dd1d1..30a5732 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v11/cachegroup.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v11/cachegroup.txt
@@ -24,7 +24,7 @@ Cache Group
/api/1.1/cachegroups
++++++++++++++++++++
-**GET /api/1.1/cachegroups.json**
+**GET /api/1.1/cachegroups**
Authentication Required: Yes
@@ -32,62 +32,72 @@ Cache Group
**Response Properties**
- +------------------------+--------+--------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +========================+========+==========================================================================+
- | ``longitude`` | string | Longitude for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupId`` | string | Identifier that refers to the 'id' field of different Cache Group entry. |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this entry was last updated |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``typeName`` | string | The name of the type of Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``name`` | string | The name of the Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``latitude`` | string | Latitude for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``id`` | string | Local unique identifier for the Cache Group |
- +------------------------+--------+--------------------------------------------------------------------------+
- | ``shortName`` | string | Abbreviation of the Cache Group Name |
- +------------------------+--------+--------------------------------------------------------------------------+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "longitude": "0",
- "parentCachegroupId": null,
+ "id": "21",
"lastUpdated": "2012-09-25 20:27:28",
- "typeName": "MID_LOC",
+ "latitude": "0",
+ "longitude": "0",
"name": "dc-chicago",
+ "parentCachegroupId": null,
"parentCachegroupName": null,
- "typeId": "4",
- "latitude": "0",
- "id": "21",
- "shortName": "dcchi"
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
},
{
+ "id": "22",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
"longitude": "0",
+ "name": "dc-chicago-1",
"parentCachegroupId": null,
- "lastUpdated": "2012-09-25 20:32:03",
- "typeName": "MID_LOC",
- "name": "dc-cmc",
"parentCachegroupName": null,
- "typeId": "4",
- "latitude": "0",
- "id": "22",
- "shortName": "dccmc"
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
}
],
}
|
-**GET /api/1.1/cachegroups/trimmed.json**
+**GET /api/1.1/cachegroups/trimmed**
Authentication Required: Yes
@@ -116,7 +126,67 @@ Cache Group
|
-**GET /api/1.1/cachegroup/:parameter_id/parameter.json**
+**GET /api/1.1/cachegroups/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ }
+ ],
+ }
+
+|
+
+
+**GET /api/1.1/cachegroup/:parameter_id/parameter**
Authentication Required: Yes
@@ -160,7 +230,7 @@ Cache Group
}
-**GET /api/1.1/cachegroupparameters.json**
+**GET /api/1.1/cachegroupparameters**
Authentication Required: Yes
@@ -207,7 +277,7 @@ Cache Group
|
-**GET /api/1.1/cachegroups/:parameter_id/parameter/available.json**
+**GET /api/1.1/cachegroups/:parameter_id/parameter/available**
Authentication Required: Yes
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v11/cdn.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v11/cdn.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v11/cdn.txt
index 001398b..1173c84 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v11/cdn.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v11/cdn.txt
@@ -24,7 +24,7 @@ CDN
/api/1.1/cdns
+++++++++++++
-**GET /api/1.1/cdns.json**
+**GET /api/1.1/cdns**
Authentication Required: Yes
@@ -32,50 +32,119 @@ CDN
**Response Properties**
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``name`` | string | CDN name. |
- +------------------+--------+-------------------------------------------------+
- | ``id`` | int | CDN id. |
- +------------------+--------+-------------------------------------------------+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
**Response Example** ::
{
"response": [
{
+ "id": "1"
"name": "over-the-top",
- "id": 1
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": true,
+ "lastUpdated": "2014-10-02 08:22:43"
}
]
}
|
-**GET /api/1.1/cdns/name/:name.json**
+**GET /api/1.1/cdns/:id**
Authentication Required: Yes
Role(s) Required: None
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | CDN id. |
+ +-----------+----------+---------------------------------------------+
+
**Response Properties**
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``name`` | string | CDN name. |
- +------------------+--------+-------------------------------------------------+
- | ``id`` | int | CDN id. |
- +------------------+--------+-------------------------------------------------+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "name": "over-the-top",
- "id": 1
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/cdns/name/:name**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``name`` | yes | CDN name. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
}
]
}
@@ -85,7 +154,7 @@ CDN
Health
++++++
-**GET /api/1.1/cdns/health.json**
+**GET /api/1.1/cdns/health**
Retrieves the health of all locations (cache groups) for all CDNs.
@@ -136,7 +205,7 @@ Health
|
-**GET /api/1.1/cdns/:name/health.json**
+**GET /api/1.1/cdns/:name/health**
Retrieves the health of all locations (cache groups) for a given CDN.
@@ -196,7 +265,7 @@ Health
|
-**GET /api/1.1/cdns/usage/overview.json**
+**GET /api/1.1/cdns/usage/overview**
Retrieves the high-level CDN usage metrics.
@@ -228,7 +297,7 @@ Health
}
-**GET /api/1.1/cdns/capacity.json**
+**GET /api/1.1/cdns/capacity**
Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.
@@ -268,7 +337,7 @@ Health
Routing
+++++++
-**GET /api/1.1/cdns/routing.json**
+**GET /api/1.1/cdns/routing**
Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.
@@ -314,7 +383,7 @@ Routing
Metrics
+++++++
-**GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end.json**
+**GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end**
Retrieves edge metrics of one or all locations (cache groups).
@@ -403,7 +472,7 @@ Metrics
Domains
+++++++
-**GET /api/1.1/cdns/domains.json**
+**GET /api/1.1/cdns/domains**
Authentication Required: Yes
@@ -453,7 +522,7 @@ Domains
Topology
++++++++
-**GET /api/1.1/cdns/:cdn_name/configs.json**
+**GET /api/1.1/cdns/:cdn_name/configs**
Retrieves CDN config information based upon the provided cdn name.
@@ -489,7 +558,7 @@ Topology
|
-**GET /api/1.1/cdns/:name/configs/monitoring.json**
+**GET /api/1.1/cdns/:name/configs/monitoring**
Retrieves CDN monitoring information.
@@ -627,7 +696,7 @@ Topology
|
-**GET /api/1.1/cdns/:name/configs/routing.json**
+**GET /api/1.1/cdns/:name/configs/routing**
Retrieves CDN routing information.
@@ -844,7 +913,7 @@ Topology
DNSSEC Keys
+++++++++++
-**GET /api/1.1/cdns/name/:name/dnsseckeys.json**
+**GET /api/1.1/cdns/name/:name/dnsseckeys**
Gets a list of dnsseckeys for CDN and all associated Delivery Services.
Before returning response to user, check to make sure keys aren't expired. If they are expired, generate new ones.
@@ -932,7 +1001,7 @@ DNSSEC Keys
|
-**GET /api/1.1/cdns/name/:name/dnsseckeys/delete.json**
+**GET /api/1.1/cdns/name/:name/dnsseckeys/delete**
Delete dnssec keys for a cdn and all associated delivery services.
[41/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/basics/caching_proxies.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/basics/caching_proxies.html b/docs/1.7.0/basics/caching_proxies.html
index d086be5..f544c4d 100644
--- a/docs/1.7.0/basics/caching_proxies.html
+++ b/docs/1.7.0/basics/caching_proxies.html
@@ -82,7 +82,7 @@
<li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Caching Proxies</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
</ul>
</li>
@@ -222,16 +222,16 @@ cache is: <code class="docutils literal"><span class="pre">http://www-origin-cac
<p class="first admonition-title">Note</p>
<p class="last">In the previous example minimal headers were shown on both the request and response. In the examples that follow, the origin server response is more realistic.</p>
</div>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
<p>The client is given the URL <code class="docutils literal"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> (note the different hostname) and when attempting to obtain that URL, the following occurs:</p>
@@ -241,8 +241,8 @@ Content-Type: text/html; charset=UTF-8
<li><p class="first">Similar to the previous case, the LDNS server resolves the name <code class="docutils literal"><span class="pre">www-origin-cache.cdn.com</span></code> to an IPv4 address, in this example, this address is 55.44.33.22.</p>
</li>
<li><p class="first">The client opens a TCP connection from a random port locally, to port 80 (the HTTP default) on 55.44.33.22, and sends the following:</p>
-<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
-Host: www-origin-cache.cdn.com
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">-</span><span class="n">origin</span><span class="o">-</span><span class="n">cache</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
@@ -255,38 +255,38 @@ Host: www-origin-cache.cdn.com
<blockquote>
<div><ol class="arabic">
<li><p class="first">The proxy uses DNS to get the IPv4 address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>, connect to it on port 80, and sends:</p>
-<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
-Host: www.origin.com
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
<li><p class="first">The origin server responds with the headers and content as shown:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p class="first">The proxy sends the origin response on to the client adding a <code class="docutils literal"><span class="pre">Via:</span></code> header (and maybe others):</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-Age: 0
-Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
-Server: ATS/4.2.1
-
- <html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+<span class="n">Age</span><span class="p">:</span> <span class="mi">0</span>
+<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
+
+ <span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</li>
@@ -295,18 +295,18 @@ Server: ATS/4.2.1
<p>6b. If it <em>is</em> in the cache:</p>
<blockquote>
<div><p>The proxy responds to the client with the previously retrieved result:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-Age: 39711
-Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
-Server: ATS/4.2.1
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+<span class="n">Age</span><span class="p">:</span> <span class="mi">39711</span>
+<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</div></blockquote>
@@ -331,7 +331,7 @@ client obtains, and is unaware of the proxy in the middle.</div></blockquote>
<li>To retrieve <code class="docutils literal"><span class="pre">http://www.origin.com/foo/bar/fun.html</span></code> URL, the client connects to 99.88.77.66 on port 8080 and sends:</li>
</ol>
<blockquote>
-<div><div class="highlight-python"><div class="highlight"><pre>GET http://www.origin.com/foo/bar/fun.html HTTP/1.1
+<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
</pre></div>
</div>
<div class="admonition note">
@@ -346,38 +346,38 @@ client obtains, and is unaware of the proxy in the middle.</div></blockquote>
<blockquote>
<div><ol class="arabic">
<li><p class="first">The proxy uses DNS to obtain the IPv4 address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>, connects to it on port 80, and sends:</p>
-<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
-Host: www.origin.com
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
<li><p class="first">The origin server responds with the headers and content as shown below:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Server: Apache/2.2.15 (Red Hat)
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</li>
<li><p class="first">The proxy sends this on to the client adding a <code class="docutils literal"><span class="pre">Via:</span></code> header (and maybe others):</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-Age: 0
-Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
-Server: ATS/4.2.1
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+<span class="n">Age</span><span class="p">:</span> <span class="mi">0</span>
+<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</li>
@@ -386,18 +386,18 @@ Server: ATS/4.2.1
<p>4b. If it <em>is</em> in the cache:</p>
<blockquote>
<div><p>The proxy responds to the client with the previously retrieved result:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Date: Sun, 14 Dec 2014 23:22:44 GMT
-Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
-ETag: "1aa008f-2d-50a3559482cc0"
-Content-Length: 45
-Connection: close
-Content-Type: text/html; charset=UTF-8
-Age: 99711
-Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
-Server: ATS/4.2.1
-
-<html><body>This is a fun file</body></html>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
+<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
+<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+<span class="n">Age</span><span class="p">:</span> <span class="mi">99711</span>
+<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
+
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</div></blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/basics/content_delivery_networks.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/basics/content_delivery_networks.html b/docs/1.7.0/basics/content_delivery_networks.html
index a36d62c..5351d03 100644
--- a/docs/1.7.0/basics/content_delivery_networks.html
+++ b/docs/1.7.0/basics/content_delivery_networks.html
@@ -80,7 +80,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="">Content Delivery Networks</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/basics/http_11.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/basics/http_11.html b/docs/1.7.0/basics/http_11.html
index aa838f3..3509cae 100644
--- a/docs/1.7.0/basics/http_11.html
+++ b/docs/1.7.0/basics/http_11.html
@@ -81,7 +81,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">HTTP 1.1</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
</ul>
@@ -201,17 +201,17 @@
</div></blockquote>
<ol class="arabic" start="3">
<li><p class="first">The client opens a TCP connection from a random port locally to port 80 (the HTTP default) on 44.33.22.11, and sends this (showing the minimum HTTP 1.1 request, typically there are additional headers):</p>
-<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
-Host: www.origin.com
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
<li><p class="first">The server at <code class="docutils literal"><span class="pre">www.origin.com</span></code> looks up the Host: header to match that to a configuration section, usually referred to as a virtual host section. If the Host: header and configuration section match, the search continues for the content of the path <code class="docutils literal"><span class="pre">/foo/bar/fun.html</span></code>, in the example, this is a file that contains <code class="docutils literal"><span class="pre"><html><body>This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">fun</span> <span class="pre">file</body></html></span></code>, so the server responds with the following:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
-Content-Type: text/html; charset=UTF-8
-Content-Length: 45
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
-<html><body>This is a fun file</body></html>
+<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/basics/index.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/basics/index.html b/docs/1.7.0/basics/index.html
index e792271..d4921fa 100644
--- a/docs/1.7.0/basics/index.html
+++ b/docs/1.7.0/basics/index.html
@@ -78,7 +78,7 @@
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="">CDN Basics</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">CDN Basics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/index.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/index.html b/docs/1.7.0/development/index.html
index 83af885..42ef17a 100644
--- a/docs/1.7.0/development/index.html
+++ b/docs/1.7.0/development/index.html
@@ -116,7 +116,7 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="">Developer’s Guide</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_monitor.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_monitor.html b/docs/1.7.0/development/traffic_monitor.html
index 55c4a6b..fa3c0f4 100644
--- a/docs/1.7.0/development/traffic_monitor.html
+++ b/docs/1.7.0/development/traffic_monitor.html
@@ -121,7 +121,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Monitor</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
</ul>
@@ -318,7 +318,7 @@
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">�</a></h2>
-<p><a class="reference internal" href="traffic_monitor/traffic_monitor_api.html#reference-tm-api"><em>Traffic Monitor APIs</em></a></p>
+<p><a class="reference internal" href="traffic_monitor/traffic_monitor_api.html#reference-tm-api"><span class="std std-ref">Traffic Monitor APIs</span></a></p>
<div class="toctree-wrapper compound">
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops.html b/docs/1.7.0/development/traffic_ops.html
index cfddbd4..fb939a1 100644
--- a/docs/1.7.0/development/traffic_ops.html
+++ b/docs/1.7.0/development/traffic_ops.html
@@ -118,7 +118,7 @@
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
@@ -264,7 +264,7 @@
<div class="section" id="perl-formatting-conventions">
<h2>Perl Formatting Conventions<a class="headerlink" href="#perl-formatting-conventions" title="Permalink to this headline">�</a></h2>
<p>Perl tidy is for use in code formatting. See the following config file for formatting conventions.</p>
-<div class="highlight-python"><div class="highlight"><pre>edit a file called $HOME/.perltidyrc
+<div class="highlight-default"><div class="highlight"><pre><span></span>edit a file called $HOME/.perltidyrc
-l=156
-et=4
@@ -350,7 +350,7 @@ environment.</td>
<li>Install the local dependencies using Carton (cpanfile).</li>
</ol>
<blockquote>
-<div><div class="highlight-python"><div class="highlight"><pre>$ cd traffic_ops/app
+<div><div class="highlight-default"><div class="highlight"><pre><span></span>$ cd traffic_ops/app
$ carton
</pre></div>
</div>
@@ -360,7 +360,7 @@ $ carton
</ol>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>master $ mysql
+<div class="highlight-default"><div class="highlight"><pre><span></span>master $ mysql
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 305
Server version: 5.6.19 Homebrew
@@ -391,7 +391,7 @@ mysql> grant all on to_integration.* to 'to_user'@'localhost'
<div class="line"><br /></div>
</div>
<p>Running the the admin.pl script in setup mode should look like this:</p>
-<div class="highlight-python"><div class="highlight"><pre>master $ db/admin.pl --env=development setup
+<div class="highlight-default"><div class="highlight"><pre><span></span>master $ db/admin.pl --env=development setup
Using database.conf: conf/development/database.conf
Using database.conf: conf/development/database.conf
Using database.conf: conf/development/database.conf
@@ -424,9 +424,9 @@ Warning: Using a password on the command line interface can be insecure.
</li>
</ol>
<blockquote>
-<div><div class="highlight-python"><div class="highlight"><pre>[2015-02-24 10:44:34,991] [INFO] Listening at "http://*:3000".
+<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="mi">2015</span><span class="o">-</span><span class="mi">02</span><span class="o">-</span><span class="mi">24</span> <span class="mi">10</span><span class="p">:</span><span class="mi">44</span><span class="p">:</span><span class="mi">34</span><span class="p">,</span><span class="mi">991</span><span class="p">]</span> <span class="p">[</span><span class="n">INFO</span><span class="p">]</span> <span class="n">Listening</span> <span class="n">at</span> <span class="s2">"http://*:3000"</span><span class="o">.</span>
-Server available at http://127.0.0.1:3000.
+<span class="n">Server</span> <span class="n">available</span> <span class="n">at</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span><span class="p">:</span><span class="mf">3000.</span>
</pre></div>
</div>
</div></blockquote>
@@ -486,14 +486,14 @@ Server available at http://127.0.0.1:3000.
</ol>
<blockquote>
<div>These allow you to add statistic sources for the graph views and APIs.</div></blockquote>
-<p>Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see <a class="reference internal" href="../admin/traffic_ops_extensions.html#admin-to-ext-script"><em>Managing Traffic Ops Extensions</em></a>.</p>
+<p>Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see <a class="reference internal" href="../admin/traffic_ops_extensions.html#admin-to-ext-script"><span class="std std-ref">Managing Traffic Ops Extensions</span></a>.</p>
<div class="section" id="check-extensions">
<h3>Check Extensions<a class="headerlink" href="#check-extensions" title="Permalink to this headline">�</a></h3>
<p>In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the “Health->Server Checks” view and that usually run periodically out of cron.</p>
<p>It is the responsibility of the check extension script to iterate over the servers it wants to check and post the results.</p>
<p>An example script might proceed by logging into the Traffic Ops server using the HTTPS base_url provided on the command line. The script is hardcoded with an auth token that is also provisioned in the Traffic Ops User database. This token allows the script to obtain a cookie used in later communications with the Traffic Ops API. The script then obtains a list of all caches to be polled by accessing Traffic Ops’ <code class="docutils literal"><span class="pre">/api/1.1/servers.json</span></code> REST target. This list is walked, running a command to gather the stats from that cache. For some extensions, an HTTP GET request might be made to the ATS astats plugin, while for others the cache might be pinged, or a command run over SSH. The results are then compiled into a numeric or boolean result and the script POSTs tha result back to the Traffic Ops <code class="docutils literal"><span class="pre">/api/1.1/servercheck/</span></code> target.</p>
<p>A check extension can have a column of <img alt="checkmark" src="../_images/good1.png" />‘s and <img alt="X" src="../_images/bad1.png" />‘s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below:</p>
-<div class="highlight-python"><div class="highlight"><pre>Script here.
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Script</span> <span class="n">here</span><span class="o">.</span>
</pre></div>
</div>
<p>Check Extension scripts are located in the $TO_HOME/bin/checks directory.</p>
@@ -508,7 +508,7 @@ Server available at http://127.0.0.1:3000.
<dt><strong>Maximum Transmission Check - MTU</strong></dt>
<dd>Checks if the Traffic Ops host (if that is the one running the check) can send and receive 8192 size packets to the <code class="docutils literal"><span class="pre">ip_address</span></code> of the server in the server table.</dd>
<dt><strong>Operational Readiness Check - ORT</strong></dt>
-<dd>See <a class="reference internal" href="../admin/traffic_server.html#reference-traffic-ops-ort"><em>Configuring Traffic Server</em></a> for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.</dd>
+<dd>See <a class="reference internal" href="../admin/traffic_server.html#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a> for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.</dd>
<dt><strong>Ping Check - 10G, ILO, 10G6, FQDN</strong></dt>
<dd><p class="first">The bin/checks/ToPingCheck.pl is to check basic IP connectivity, and in the default setup it checks IP connectivity to the following:</p>
<dl class="last docutils">
@@ -541,7 +541,7 @@ Server available at http://127.0.0.1:3000.
<div class="section" id="extension-directories">
<h3>Extension Directories<a class="headerlink" href="#extension-directories" title="Permalink to this headline">�</a></h3>
<p>PERL5LIB Example Configuration:</p>
-<div class="highlight-python"><div class="highlight"><pre>export PERL5LIB=/opt/traffic_ops_extensions/private/lib/Extensions:/opt/traffic_ops/app/lib/Extensions/TrafficStats
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops_extensions</span><span class="o">/</span><span class="n">private</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="o">/</span><span class="n">TrafficStats</span>
</pre></div>
</div>
</div>
@@ -568,9 +568,9 @@ Extensions::YourCustomExtension</p>
<div class="section" id="response-structure">
<h3>Response Structure<a class="headerlink" href="#response-structure" title="Permalink to this headline">�</a></h3>
<p>All successful responses have the following structure:</p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": <JSON object with main response>,
-}
+<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="o"><</span><span class="n">JSON</span> <span class="nb">object</span> <span class="k">with</span> <span class="n">main</span> <span class="n">response</span><span class="o">></span><span class="p">,</span>
+<span class="p">}</span>
</pre></div>
</div>
<p>To make the documentation easier to read, only the <code class="docutils literal"><span class="pre"><JSON</span> <span class="pre">object</span> <span class="pre">with</span> <span class="pre">main</span> <span class="pre">response></span></code> is documented, even though the response and version fields are always present.</p>
@@ -583,7 +583,7 @@ Extensions::YourCustomExtension</p>
<li>Pass the mojolicious cookie value, along with any subsequent calls to an authenticated API endpoint.</li>
</ol>
<p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+<div class="highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
{"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
[jvd@laika ~]$
[jvd@laika ~]$ curl -v -H "Accept: application/json" -v -X POST --data '{ "u":"admin", "p":"secret_passwd" }' http://localhost:3000/api/1.1/user/login
@@ -658,7 +658,7 @@ Extensions::YourCustomExtension</p>
<dl class="docutils">
<dt>401 Unauthorized</dt>
<dd><p class="first">When you don’t supply the right cookie, this is the response.</p>
-<div class="last highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+<div class="last highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
* Hostname was NOT found in DNS cache
* Trying ::1...
* connect to ::1 port 3000 failed: Connection refused
@@ -690,7 +690,7 @@ Extensions::YourCustomExtension</p>
</dd>
<dt>404 Not Found</dt>
<dd><p class="first">When the resource (path) is non existent Traffic Ops returns a 404:</p>
-<div class="last highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json
+<div class="last highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json
* Hostname was NOT found in DNS cache
* Trying ::1...
* connect to ::1 port 3000 failed: Connection refused
@@ -724,7 +724,7 @@ Extensions::YourCustomExtension</p>
</dd>
<dt>500 Internal Server Error</dt>
<dd><p class="first">When you are asking for a correct path, but the database doesn’t match, it returns a 500:</p>
-<div class="highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json
+<div class="highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json
* Hostname was NOT found in DNS cache
* Trying ::1...
* connect to ::1 port 3000 failed: Connection refused
@@ -803,13 +803,14 @@ Extensions::YourCustomExtension</p>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/changelog.html">Change Logs</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice.html">Delivery Service</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice_stats.html">Delivery Service Statistics</a></li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/division.html">Divisions</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/federation.html">Federation</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/hwinfo.html">Hardware Info</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/parameter.html">Parameter</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/phys_location.html">Physical Location</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/profile.html">Profiles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/profile_parameter.html">Profile parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/influxdb.html">InfluxDB</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/division.html">Divisions</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/region.html">Regions</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/role.html">Roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/server.html">Server</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/routes.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/routes.html b/docs/1.7.0/development/traffic_ops_api/routes.html
index 2a8e150..b8d9efd 100644
--- a/docs/1.7.0/development/traffic_ops_api/routes.html
+++ b/docs/1.7.0/development/traffic_ops_api/routes.html
@@ -224,16 +224,16 @@ table.docutils col:nth-child(3) {
</thead>
<tbody valign="top">
<tr class="row-even"><td>/asns</td>
-<td><a class="reference internal" href="v11/asn.html#to-api-v11-asns-route"><em>/api/1.1/asns</em></a></td>
-<td><a class="reference internal" href="v12/asn.html#to-api-v12-asns-route"><em>/api/1.2/asns</em></a></td>
+<td><a class="reference internal" href="v11/asn.html#to-api-v11-asns-route"><span class="std std-ref">/api/1.1/asns</span></a></td>
+<td><a class="reference internal" href="v12/asn.html#to-api-v12-asns-route"><span class="std std-ref">/api/1.2/asns</span></a></td>
</tr>
<tr class="row-odd"><td>/availableds</td>
-<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><em>/api/1.1/deliveryservices</em></a></td>
-<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><em>/api/1.2/deliveryservices</em></a></td>
+<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td>
+<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td>
</tr>
<tr class="row-even"><td><em>Not Implemented</em></td>
<td><em>Not Implemented</em></td>
-<td><a class="reference internal" href="v12/cache_stats.html#to-api-v12-cache-stats-route"><em>/api/1.2/cache_stats</em></a></td>
+<td><a class="reference internal" href="v12/cache_stats.html#to-api-v12-cache-stats-route"><span class="std std-ref">/api/1.2/cache_stats</span></a></td>
</tr>
<tr class="row-odd"><td>/datacrans</td>
<td>/api/1.1/crans.json</td>
@@ -244,8 +244,8 @@ table.docutils col:nth-child(3) {
<td>/api/1.2/crans.json</td>
</tr>
<tr class="row-odd"><td>/datadeliveryservice</td>
-<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><em>/api/1.1/deliveryservices</em></a></td>
-<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><em>/api/1.2/deliveryservices</em></a></td>
+<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td>
+<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td>
</tr>
<tr class="row-even"><td>/datadeliveryserviceserver</td>
<td>/api/1.1/deliveryserviceserver.json</td>
@@ -257,11 +257,11 @@ table.docutils col:nth-child(3) {
</tr>
<tr class="row-even"><td><em>Not Implemented</em></td>
<td><em>Not Implemented</em></td>
-<td><a class="reference internal" href="v12/deliveryservice_stats.html#to-api-v12-ds-stats-route"><em>/api/1.2/deliveryservice_stats</em></a></td>
+<td><a class="reference internal" href="v12/deliveryservice_stats.html#to-api-v12-ds-stats-route"><span class="std std-ref">/api/1.2/deliveryservice_stats</span></a></td>
</tr>
<tr class="row-odd"><td>/datahwinfo</td>
-<td><a class="reference internal" href="v11/hwinfo.html#to-api-v11-hwinfo-route"><em>/api/1.1/hwinfo</em></a></td>
-<td><a class="reference internal" href="v12/hwinfo.html#to-api-v12-hwinfo-route"><em>/api/1.2/hwinfo</em></a></td>
+<td><a class="reference internal" href="v11/hwinfo.html#to-api-v11-hwinfo-route"><span class="std std-ref">/api/1.1/hwinfo</span></a></td>
+<td><a class="reference internal" href="v12/hwinfo.html#to-api-v12-hwinfo-route"><span class="std std-ref">/api/1.2/hwinfo</span></a></td>
</tr>
<tr class="row-even"><td>/datalinks</td>
<td>/api/1.1/deliveryserviceserver.json</td>
@@ -272,86 +272,86 @@ table.docutils col:nth-child(3) {
<td>/api/1.2/deliveryserviceserver.json</td>
</tr>
<tr class="row-even"><td>/datalogs</td>
-<td><a class="reference internal" href="v11/changelog.html#to-api-v11-change-logs-route"><em>/api/1.1/logs</em></a></td>
-<td><a class="reference internal" href="v12/changelog.html#to-api-v12-change-logs-route"><em>/api/1.2/logs</em></a></td>
+<td><a class="reference internal" href="v11/changelog.html#to-api-v11-change-logs-route"><span class="std std-ref">/api/1.1/logs</span></a></td>
+<td><a class="reference internal" href="v12/changelog.html#to-api-v12-change-logs-route"><span class="std std-ref">/api/1.2/logs</span></a></td>
</tr>
<tr class="row-odd"><td>/datalocation/orderby/id</td>
-<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><em>/api/1.1/cachegroups</em></a></td>
-<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><em>/api/1.2/cachegroups</em></a></td>
+<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td>
+<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td>
</tr>
<tr class="row-even"><td>/datalocationparameters</td>
-<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><em>/api/1.1/cachegroups</em></a></td>
-<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><em>/api/1.2/cachegroups</em></a></td>
+<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td>
+<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td>
</tr>
<tr class="row-odd"><td>/dataparameter</td>
-<td><a class="reference internal" href="v11/parameter.html#to-api-v11-parameters-route"><em>/api/1.1/parameters</em></a></td>
-<td><a class="reference internal" href="v12/parameter.html#to-api-v12-parameters-route"><em>/api/1.2/parameters</em></a></td>
+<td><a class="reference internal" href="v11/parameter.html#to-api-v11-parameters-route"><span class="std std-ref">/api/1.1/parameters</span></a></td>
+<td><a class="reference internal" href="v12/parameter.html#to-api-v12-parameters-route"><span class="std std-ref">/api/1.2/parameters</span></a></td>
</tr>
<tr class="row-even"><td>/dataparameter/:parameter</td>
<td>/api/1.1/parameters/profile/:parameter.json</td>
<td>/api/1.2/parameters/profile/:parameter.json</td>
</tr>
<tr class="row-odd"><td>/dataphys_location</td>
-<td><a class="reference internal" href="v11/phys_location.html#to-api-v11-phys-loc-route"><em>/api/1.1/phys_locations</em></a></td>
-<td><a class="reference internal" href="v12/phys_location.html#to-api-v12-phys-loc-route"><em>/api/1.2/phys_locations</em></a></td>
+<td><a class="reference internal" href="v11/phys_location.html#to-api-v11-phys-loc-route"><span class="std std-ref">/api/1.1/phys_locations</span></a></td>
+<td><a class="reference internal" href="v12/phys_location.html#to-api-v12-phys-loc-route"><span class="std std-ref">/api/1.2/phys_locations</span></a></td>
</tr>
<tr class="row-even"><td><p class="first">/dataprofile</p>
<p class="last">/dataprofile/orderby/name</p>
</td>
-<td><a class="reference internal" href="v11/profile.html#to-api-v11-profiles-route"><em>/api/1.1/profiles</em></a></td>
-<td><a class="reference internal" href="v12/profile.html#to-api-v12-profiles-route"><em>/api/1.2/profiles</em></a></td>
+<td><a class="reference internal" href="v11/profile.html#to-api-v11-profiles-route"><span class="std std-ref">/api/1.1/profiles</span></a></td>
+<td><a class="reference internal" href="v12/profile.html#to-api-v12-profiles-route"><span class="std std-ref">/api/1.2/profiles</span></a></td>
</tr>
<tr class="row-odd"><td>/dataregion</td>
-<td><a class="reference internal" href="v11/region.html#to-api-v11-regions-route"><em>/api/1.1/regions</em></a></td>
-<td><a class="reference internal" href="v12/region.html#to-api-v12-regions-route"><em>/api/1.2/regions</em></a></td>
+<td><a class="reference internal" href="v11/region.html#to-api-v11-regions-route"><span class="std std-ref">/api/1.1/regions</span></a></td>
+<td><a class="reference internal" href="v12/region.html#to-api-v12-regions-route"><span class="std std-ref">/api/1.2/regions</span></a></td>
</tr>
<tr class="row-even"><td>/datarole</td>
-<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><em>/api/1.1/roles</em></a></td>
-<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><em>/api/1.2/roles</em></a></td>
+<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td>
+<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td>
</tr>
<tr class="row-odd"><td>/datarole/orderby/:field</td>
-<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><em>/api/1.1/roles</em></a></td>
-<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><em>/api/1.2/roles</em></a></td>
+<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td>
+<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td>
</tr>
<tr class="row-even"><td>/dataserver</td>
-<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><em>/api/1.1/servers</em></a></td>
-<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><em>/api/1.2/servers</em></a></td>
+<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td>
+<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td>
</tr>
<tr class="row-odd"><td>/dataserver/orderby/:field</td>
-<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><em>/api/1.1/servers</em></a></td>
-<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><em>/api/1.2/servers</em></a></td>
+<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td>
+<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td>
</tr>
<tr class="row-even"><td>/dataserverdetail/select/:hostname</td>
<td>/api/1.1/servers/hostname/:hostname/details.json</td>
<td>/api/1.2/servers/hostname/:hostname/details.json</td>
</tr>
<tr class="row-odd"><td>/datastaticdnsentry</td>
-<td><a class="reference internal" href="v11/static_dns.html#to-api-v11-static-dns-route"><em>/api/1.1/staticdnsentries</em></a></td>
-<td><a class="reference internal" href="v12/static_dns.html#to-api-v12-static-dns-route"><em>/api/1.2/staticdnsentries</em></a></td>
+<td><a class="reference internal" href="v11/static_dns.html#to-api-v11-static-dns-route"><span class="std std-ref">/api/1.1/staticdnsentries</span></a></td>
+<td><a class="reference internal" href="v12/static_dns.html#to-api-v12-static-dns-route"><span class="std std-ref">/api/1.2/staticdnsentries</span></a></td>
</tr>
<tr class="row-even"><td>/datastatus</td>
-<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><em>/api/1.1/statuses</em></a></td>
-<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><em>/api/1.2/statuses</em></a></td>
+<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td>
+<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td>
</tr>
<tr class="row-odd"><td>/datastatus/orderby/name</td>
-<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><em>/api/1.1/statuses</em></a></td>
-<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><em>/api/1.2/statuses</em></a></td>
+<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td>
+<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td>
</tr>
<tr class="row-even"><td>/datatype</td>
-<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><em>/api/1.1/types</em></a></td>
-<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><em>/api/1.2/types</em></a></td>
+<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td>
+<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td>
</tr>
<tr class="row-odd"><td>/datatype/orderby/:field</td>
-<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><em>/api/1.1/types</em></a></td>
-<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><em>/api/1.2/types</em></a></td>
+<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td>
+<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td>
</tr>
<tr class="row-even"><td>/datauser</td>
-<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><em>/api/1.1/users</em></a></td>
-<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><em>/api/1.2/users</em></a></td>
+<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td>
+<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td>
</tr>
<tr class="row-odd"><td>/datauser/orderby/:field</td>
-<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><em>/api/1.1/users</em></a></td>
-<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><em>/api/1.2/users</em></a></td>
+<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td>
+<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td>
</tr>
</tbody>
</table>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_ops_api/v11/asn.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_ops_api/v11/asn.html b/docs/1.7.0/development/traffic_ops_api/v11/asn.html
index f0dc567..9172657 100644
--- a/docs/1.7.0/development/traffic_ops_api/v11/asn.html
+++ b/docs/1.7.0/development/traffic_ops_api/v11/asn.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-asn"></span><h1>ASN<a class="headerlink" href="#asn" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-asns">
<span id="to-api-v11-asns-route"></span><h2>/api/1.1/asns<a class="headerlink" href="#api-1-1-asns" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/asns.json</strong></p>
+<p><strong>GET /api/1.1/asns</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -231,20 +231,20 @@
</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">"asns"</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="s2">"asns"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span>
- <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7015"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</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">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"28"</span><span class="p">,</span>
- <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7016"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-pa-pittsburgh"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
[47/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/_sources/development/traffic_ops_api/v12/deliveryservice.txt
----------------------------------------------------------------------
diff --git a/docs/1.7.0/_sources/development/traffic_ops_api/v12/deliveryservice.txt b/docs/1.7.0/_sources/development/traffic_ops_api/v12/deliveryservice.txt
index 5ca4bb3..a6a6b66 100644
--- a/docs/1.7.0/_sources/development/traffic_ops_api/v12/deliveryservice.txt
+++ b/docs/1.7.0/_sources/development/traffic_ops_api/v12/deliveryservice.txt
@@ -35,174 +35,224 @@ Delivery Service
**Response Properties**
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description | |
- +==========================+========+======================================================================================================================================+=====================================================================================================+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``active`` | bool | true if active, false if inactive. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE | |
- | | | - 1: serve with https:// at EDGE | |
- | | | - 2: serve with both http:// and https:// at EDGE | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | string | - 0: None - no limitations | |
- | | | - 1: Only route on CZF file hit | |
- | | | - 2: Only route on CZF hit or when from USA | |
- | | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents | |
- | | | routing to the content by Traffic Router. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectURL`` | string | This is the URL Traffic Router will redirect to when Geo Limit Failure. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the | |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded | |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for | |
- | | | HTTP deliveryservices | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``headerRewrite`` | string | The EDGE header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the | |
- | | | globalMaxMbps traffic on this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``id`` | string | The deliveryservice id (database row number). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field 1. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 2. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``matchList`` | array | Array of matchList hashes. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v12-types use_in_table='regex'). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all | |
- | | | available). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | string | | Is the Multi Site Origin feature enabled for this delivery service. See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the | |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. | |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. | |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. | |
- | | | - true: token based auth is enabled for this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: | |
- | | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) | |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. | |
- | | | - 2 Use the cache_range_requests plugin. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "geoLimitRedirectURL": "",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
- },
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
{ .. },
{ .. }
- ],
+ ]
}
|
-**GET /api/1.2/deliveryservices/:id.json**
+
+**GET /api/1.2/deliveryservices/:id**
Retrieves a specific delivery service. See also `Using Traffic Ops - Delivery Service <http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
@@ -215,20 +265,20 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+========+======================================================================================================================================+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``active`` | bool | true if active, false if inactive. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -241,6 +291,10 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimit`` | string | - 0: None - no limitations |
| | | - 1: Only route on CZF file hit |
| | | - 2: Only route on CZF hit or when from USA |
@@ -248,7 +302,9 @@ Delivery Service
| | | Note that this does not prevent access to content or makes content secure; it just prevents |
| | | routing to the content by Traffic Router. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectURL`` | string | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
| | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
@@ -257,8 +313,6 @@ Delivery Service
| | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
| | | HTTP deliveryservices |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``headerRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -266,8 +320,14 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc`` | string | Description field 1. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``longDesc1`` | string | Description field 2. |
@@ -276,7 +336,7 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``matchList`` | array | Array of matchList hashes. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v12-types use_in_table='regex'). |
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``>>setNumber`` | string | The set Number of the matchList. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -285,39 +345,61 @@ Delivery Service
| ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
| | | available). |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
| | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
| | | - 2: drop query string at edge, and do not use it in the cache-key. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``remapText`` | string | Additional raw remap line text. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
| | | - true: token based auth is enabled for this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
+ | ``trResponseHeaders`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | string | Entry points in to the CDN for this deliveryservice. |
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -325,54 +407,76 @@ Delivery Service
{
"response": [
{
- "active": true,
- "cacheurl": null,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "geoLimitRedirectURL":"",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
}
- ],
+ ]
}
+|
+
+
.. _to-api-v12-ds-health:
Health
@@ -395,7 +499,11 @@ Health
+------------------+---------+-------------------------------------------------+
| ``>locations`` | array | |
+------------------+---------+-------------------------------------------------+
- | ``>destination`` | string | |
+ | ``>destination`` | hash |
<TRUNCATED>
[27/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_portal.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_portal.html b/docs/1.7.0/development/traffic_portal.html
index 9e171b9..49904cc 100644
--- a/docs/1.7.0/development/traffic_portal.html
+++ b/docs/1.7.0/development/traffic_portal.html
@@ -119,7 +119,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Portal</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_router.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_router.html b/docs/1.7.0/development/traffic_router.html
index e218117..27e6e98 100644
--- a/docs/1.7.0/development/traffic_router.html
+++ b/docs/1.7.0/development/traffic_router.html
@@ -120,7 +120,7 @@
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Router</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
@@ -374,7 +374,7 @@
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">�</a></h2>
-<p><a class="reference internal" href="traffic_router/traffic_router_api.html#reference-tr-api"><em>Traffic Router API</em></a></p>
+<p><a class="reference internal" href="traffic_router/traffic_router_api.html#reference-tr-api"><span class="std std-ref">Traffic Router API</span></a></p>
<div class="toctree-wrapper compound">
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_server.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_server.html b/docs/1.7.0/development/traffic_server.html
index dfcdd5f..b678c86 100644
--- a/docs/1.7.0/development/traffic_server.html
+++ b/docs/1.7.0/development/traffic_server.html
@@ -123,7 +123,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Server</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Server</a></li>
</ul>
</li>
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/development/traffic_stats.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/development/traffic_stats.html b/docs/1.7.0/development/traffic_stats.html
index b3baac6..736dafc 100644
--- a/docs/1.7.0/development/traffic_stats.html
+++ b/docs/1.7.0/development/traffic_stats.html
@@ -122,7 +122,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Stats</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
</ul>
</li>
@@ -195,10 +195,10 @@
<p>To work on Traffic Stats you need a *nix (MacOS and Linux are most commonly used) environment that has the following installed:</p>
<blockquote>
<div><ul class="simple">
-<li><a class="reference external" href="https://golang.org/doc/install">Go 1.5.x or above</a></li>
+<li><a class="reference external" href="https://golang.org/doc/install">Go 1.7.x or above</a></li>
<li>Access to a working instance of Traffic Ops</li>
<li>Access to a working instance of Traffic Monitor</li>
-<li><a class="reference external" href="https://influxdb.com/download/index.html">InfluxDb version 0.10.0 or greater</a></li>
+<li><a class="reference external" href="https://influxdb.com/download/index.html">InfluxDb version 1.0.0 or greater</a></li>
</ul>
</div></blockquote>
</div>
@@ -208,12 +208,13 @@
<div><ul class="simple">
<li><strong>traffic_control/traffic_stats</strong> - contains Go source files and Files used to create the Traffic Stats rpm.</li>
<li><strong>traffic_control/traffic_stats/grafana/</strong> - contains a javascript file which is installed on the grafana server. This allows Traffic Ops to create custom dashboards for Delivery Services, Caches, etc.</li>
+<li><strong>traffic_control/traffic_stats/influxdb_tools/</strong> - contains one tool to create the databases and retention policies needed by Traffic Stats as well as continuous queries to downsample data; contains another tool to sync downsampled data between influxdb instances. This is is helpful if you have multiple instances and they get out of sync with data.</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="go-formatting-conventions">
<h2>Go Formatting Conventions<a class="headerlink" href="#go-formatting-conventions" title="Permalink to this headline">�</a></h2>
-<p>In general <a class="reference external" href="https://golang.org/cmd/gofmt/">Go fmt</a> is the standard for formatting go code.</p>
+<p>In general <a class="reference external" href="https://golang.org/cmd/gofmt/">Go fmt</a> is the standard for formatting go code. It is also recommended to use <a class="reference external" href="https://github.com/golang/lint">Go lint</a>.</p>
</div>
<div class="section" id="installing-the-developer-environment">
<h2>Installing The Developer Environment<a class="headerlink" href="#installing-the-developer-environment" title="Permalink to this headline">�</a></h2>
@@ -232,8 +233,7 @@
<div class="section" id="test-cases">
<h2>Test Cases<a class="headerlink" href="#test-cases" title="Permalink to this headline">�</a></h2>
<blockquote>
-<div>Currently there are not automated tests for Traffic Stats :(.
-We hope to remedy this problem very soon!</div></blockquote>
+<div>Currently there are no automated tests for Traffic Stats :( but pull requests are always welcome to fix this problem!</div></blockquote>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/faq/administration.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/faq/administration.html b/docs/1.7.0/faq/administration.html
index 23f3a32..2619629 100644
--- a/docs/1.7.0/faq/administration.html
+++ b/docs/1.7.0/faq/administration.html
@@ -131,7 +131,7 @@
<li class="toctree-l1 current"><a class="reference internal" href="index.html">FAQ</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="general.html">General</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.html">Development</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Running a Traffic Control CDN</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Running a Traffic Control CDN</a></li>
</ul>
</li>
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/faq/development.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/faq/development.html b/docs/1.7.0/faq/development.html
index 5bb7603..d7ecf38 100644
--- a/docs/1.7.0/faq/development.html
+++ b/docs/1.7.0/faq/development.html
@@ -130,7 +130,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">FAQ</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="general.html">General</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Development</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Development</a></li>
<li class="toctree-l2"><a class="reference internal" href="administration.html">Running a Traffic Control CDN</a></li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/faq/general.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/faq/general.html b/docs/1.7.0/faq/general.html
index 4180f44..6b229d1 100644
--- a/docs/1.7.0/faq/general.html
+++ b/docs/1.7.0/faq/general.html
@@ -129,7 +129,7 @@
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">FAQ</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="">General</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">General</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.html">Development</a></li>
<li class="toctree-l2"><a class="reference internal" href="administration.html">Running a Traffic Control CDN</a></li>
</ul>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/faq/index.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/faq/index.html b/docs/1.7.0/faq/index.html
index 2a4b25a..654f412 100644
--- a/docs/1.7.0/faq/index.html
+++ b/docs/1.7.0/faq/index.html
@@ -127,7 +127,7 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="">FAQ</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="general.html">General</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.html">Development</a></li>
<li class="toctree-l2"><a class="reference internal" href="administration.html">Running a Traffic Control CDN</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/genindex.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/genindex.html b/docs/1.7.0/genindex.html
index e86b724..d94ebda 100644
--- a/docs/1.7.0/genindex.html
+++ b/docs/1.7.0/genindex.html
@@ -203,7 +203,7 @@
</dl></td>
<td style="width: 33%" valign="top"><dl>
- <dt><a href="glossary.html#term-content-routing"><strong>302 content routing</strong></a>
+ <dt><a href="glossary.html#term-302-content-routing"><strong>302 content routing</strong></a>
</dt>
</dl></td>
@@ -271,7 +271,7 @@
</dt>
- <dt><a href="glossary.html#term-5"><strong>content routing</strong></a>
+ <dt><a href="glossary.html#term-content-routing"><strong>content routing</strong></a>
</dt>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/glossary.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/glossary.html b/docs/1.7.0/glossary.html
index f0f8e44..4bcc93b 100644
--- a/docs/1.7.0/glossary.html
+++ b/docs/1.7.0/glossary.html
@@ -134,7 +134,7 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="">Glossary</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Glossary</a></li>
</ul>
@@ -181,44 +181,44 @@
<div class="section" id="glossary">
<span id="id1"></span><h1>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">�</a></h1>
<dl class="glossary docutils">
-<dt id="term-content-routing">302 content routing</dt>
-<dd><a class="reference internal" href="overview/traffic_router.html#rl-http-cr"><em> HTTP Content Routing</em></a>.</dd>
+<dt id="term-302-content-routing">302 content routing</dt>
+<dd><a class="reference internal" href="overview/traffic_router.html#rl-http-cr"><span class="std std-ref"> HTTP Content Routing</span></a>.</dd>
<dt id="term-astats-stats-over-http">astats (stats_over_http)</dt>
-<dd>An ATS plugin that allows you to monitor vitals of the ATS server. See <a class="reference internal" href="overview/traffic_monitor.html#rl-astats"><em> Cache Monitoring</em></a>.</dd>
+<dd>An ATS plugin that allows you to monitor vitals of the ATS server. See <a class="reference internal" href="overview/traffic_monitor.html#rl-astats"><span class="std std-ref"> Cache Monitoring</span></a>.</dd>
<dt id="term-cache">cache</dt>
-<dd>A caching proxy server. See <a class="reference internal" href="basics/caching_proxies.html#rl-caching-proxy"><em>Caching Proxies</em></a>.</dd>
+<dd>A caching proxy server. See <a class="reference internal" href="basics/caching_proxies.html#rl-caching-proxy"><span class="std std-ref">Caching Proxies</span></a>.</dd>
<dt id="term-cachegroup">cachegroup</dt>
-<dd>A group of caches that together create a combined larger cache using consistent hashing. See <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><em> Cache Group</em></a>.</dd>
+<dd>A group of caches that together create a combined larger cache using consistent hashing. See <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><span class="std std-ref"> Cache Group</span></a>.</dd>
<dt id="term-consistent-hashing">consistent hashing</dt>
-<dd>See <a class="reference external" href="http://en.wikipedia.org/wiki/Consistent_hashing">the Wikipedia article</a>; Traffic Control uses consistent hashing when using <a class="reference internal" href="overview/traffic_router.html#rl-http-cr"><em> HTTP Content Routing</em></a> for the edge tier and when selecting parents in the mid tier.</dd>
-<dt id="term-5">content routing</dt>
-<dd>Directing clients (or client systems) to a particular location or device in a location for optimal delivery of content See also <a class="reference internal" href="overview/traffic_router.html#rl-http-cr"><em> HTTP Content Routing</em></a> and <a class="reference internal" href="overview/traffic_router.html#rl-dns-cr"><em> DNS Content Routing</em></a>.</dd>
+<dd>See <a class="reference external" href="http://en.wikipedia.org/wiki/Consistent_hashing">the Wikipedia article</a>; Traffic Control uses consistent hashing when using <a class="reference internal" href="overview/traffic_router.html#rl-http-cr"><span class="std std-ref"> HTTP Content Routing</span></a> for the edge tier and when selecting parents in the mid tier.</dd>
+<dt id="term-content-routing">content routing</dt>
+<dd>Directing clients (or client systems) to a particular location or device in a location for optimal delivery of content See also <a class="reference internal" href="overview/traffic_router.html#rl-http-cr"><span class="std std-ref"> HTTP Content Routing</span></a> and <a class="reference internal" href="overview/traffic_router.html#rl-dns-cr"><span class="std std-ref"> DNS Content Routing</span></a>.</dd>
<dt id="term-coverage-zone-map">coverage zone map</dt>
-<dd>The coverage zone map (czm) or coverage zone file (zcf) is a file that maps network prefixes to cachegroups. See <a class="reference internal" href="overview/traffic_router.html#rl-localization"><em> Localization</em></a>.</dd>
+<dd>The coverage zone map (czm) or coverage zone file (zcf) is a file that maps network prefixes to cachegroups. See <a class="reference internal" href="overview/traffic_router.html#rl-localization"><span class="std std-ref"> Localization</span></a>.</dd>
<dt id="term-delivery-service">delivery service</dt>
-<dd>A grouping of content in the CDN, usually a determined by the URL hostname. See <a class="reference internal" href="overview/traffic_router.html#rl-ds"><em> Delivery Service</em></a>.</dd>
+<dd>A grouping of content in the CDN, usually a determined by the URL hostname. See <a class="reference internal" href="overview/traffic_router.html#rl-ds"><span class="std std-ref"> Delivery Service</span></a>.</dd>
<dt id="term-edge-tier-or-cache">edge (tier or cache)</dt>
-<dd>Closest to the client or end-user. The edge tier is the tier that serves the client, edge caches are caches in the edge tier. In a Traffic Control CDN the basic function of the edge cache is that of a <a class="reference internal" href="basics/caching_proxies.html#rl-rev-proxy"><em> Reverse Proxy</em></a>. See also <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><em> Cache Group</em></a>.</dd>
+<dd>Closest to the client or end-user. The edge tier is the tier that serves the client, edge caches are caches in the edge tier. In a Traffic Control CDN the basic function of the edge cache is that of a <a class="reference internal" href="basics/caching_proxies.html#rl-rev-proxy"><span class="std std-ref"> Reverse Proxy</span></a>. See also <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><span class="std std-ref"> Cache Group</span></a>.</dd>
<dt id="term-traffic-ops-extension">(traffic ops) extension</dt>
-<dd>Using <em>extensions</em>, Traffic Ops be extended to use proprietary checks or monitoring sources. See <a class="reference internal" href="overview/traffic_ops.html#rl-trops-ext"><em> Traffic Ops Extension</em></a>.</dd>
+<dd>Using <em>extensions</em>, Traffic Ops be extended to use proprietary checks or monitoring sources. See <a class="reference internal" href="overview/traffic_ops.html#rl-trops-ext"><span class="std std-ref"> Traffic Ops Extension</span></a>.</dd>
<dt id="term-forward-proxy">forward proxy</dt>
-<dd>A proxy that works that acts like it is the client to the origin. See <a class="reference internal" href="basics/caching_proxies.html#rl-fwd-proxy"><em> Forward Proxy</em></a>.</dd>
+<dd>A proxy that works that acts like it is the client to the origin. See <a class="reference internal" href="basics/caching_proxies.html#rl-fwd-proxy"><span class="std std-ref"> Forward Proxy</span></a>.</dd>
<dt id="term-geo-localization-or-geo-routing">geo localization or geo routing</dt>
<dd>Localizing clients to the nearest caches using a geo database like the one from Maxmind.</dd>
<dt id="term-health-protocol">health protocol</dt>
-<dd>The protocol to monitor the health of all the caches. See <a class="reference internal" href="overview/traffic_monitor.html#rl-health-proto"><em> Health Protocol</em></a>.</dd>
+<dd>The protocol to monitor the health of all the caches. See <a class="reference internal" href="overview/traffic_monitor.html#rl-health-proto"><span class="std std-ref"> Health Protocol</span></a>.</dd>
<dt id="term-localization">localization</dt>
-<dd>Finding location on the network, or on planet earth. See <a class="reference internal" href="overview/traffic_router.html#rl-localization"><em> Localization</em></a>.</dd>
+<dd>Finding location on the network, or on planet earth. See <a class="reference internal" href="overview/traffic_router.html#rl-localization"><span class="std std-ref"> Localization</span></a>.</dd>
<dt id="term-mid-tier-or-cache">mid (tier or cache)</dt>
-<dd>The tier above the edge tier. The mid tier does not directly serves the end-user and is used as an additional layer between the edge and the origin. In a Traffic Control CDN the basic function of the mid cache is that of a <a class="reference internal" href="basics/caching_proxies.html#rl-fwd-proxy"><em> Forward Proxy</em></a>. See also <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><em> Cache Group</em></a>.</dd>
+<dd>The tier above the edge tier. The mid tier does not directly serves the end-user and is used as an additional layer between the edge and the origin. In a Traffic Control CDN the basic function of the mid cache is that of a <a class="reference internal" href="basics/caching_proxies.html#rl-fwd-proxy"><span class="std std-ref"> Forward Proxy</span></a>. See also <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><span class="std std-ref"> Cache Group</span></a>.</dd>
<dt id="term-origin">origin</dt>
<dd>The source of content for the CDN. Usually a redundant HTTP/1.1 webserver.</dd>
<dt id="term-parent-cache-or-cachegroup">parent (cache or cachegroup)</dt>
-<dd>The (group of) cache(s) in the higher tier. See <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><em> Cache Group</em></a>.</dd>
+<dd>The (group of) cache(s) in the higher tier. See <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><span class="std std-ref"> Cache Group</span></a>.</dd>
<dt id="term-profile">profile</dt>
-<dd>A group of settings (parameters) that will be applied to a server. See <a class="reference internal" href="overview/traffic_server.html#rl-profile"><em> Profile</em></a>.</dd>
+<dd>A group of settings (parameters) that will be applied to a server. See <a class="reference internal" href="overview/traffic_server.html#rl-profile"><span class="std std-ref"> Profile</span></a>.</dd>
<dt id="term-reverse-proxy">reverse proxy</dt>
-<dd>A proxy that acts like it is the origin to the client. See <a class="reference internal" href="basics/caching_proxies.html#rl-rev-proxy"><em> Reverse Proxy</em></a>.</dd>
+<dd>A proxy that acts like it is the origin to the client. See <a class="reference internal" href="basics/caching_proxies.html#rl-rev-proxy"><span class="std std-ref"> Reverse Proxy</span></a>.</dd>
</dl>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/index.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/index.html b/docs/1.7.0/index.html
index 8ebab75..b540afe 100644
--- a/docs/1.7.0/index.html
+++ b/docs/1.7.0/index.html
@@ -283,12 +283,13 @@
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#event-log-file-format">Event Log File Format</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#geolimit-failure-redirect-feature">GeoLimit Failure Redirect feature</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#steering-feature">Steering feature</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#https-for-http-type-delivery-services">HTTPS for Http Type Delivery Services</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_stats.html">Traffic Stats Administration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_stats.html#installation">Installation</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_stats.html#configuration">Configuration</a></li>
-<li class="toctree-l3"><a class="reference internal" href="admin/traffic_stats.html#id1">InfluxDb Tools</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_stats.html#id2">InfluxDb Tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_server.html">Traffic Server Administration</a><ul>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/objects.inv
----------------------------------------------------------------------
diff --git a/docs/1.7.0/objects.inv b/docs/1.7.0/objects.inv
index f612a40..ea2d450 100644
Binary files a/docs/1.7.0/objects.inv and b/docs/1.7.0/objects.inv differ
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/overview/index.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/overview/index.html b/docs/1.7.0/overview/index.html
index 66ac442..725b4ed 100644
--- a/docs/1.7.0/overview/index.html
+++ b/docs/1.7.0/overview/index.html
@@ -87,7 +87,7 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="">Traffic Control Overview</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Traffic Control Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/overview/introduction.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/overview/introduction.html b/docs/1.7.0/overview/introduction.html
index 37b8d93..f2bbb92 100644
--- a/docs/1.7.0/overview/introduction.html
+++ b/docs/1.7.0/overview/introduction.html
@@ -89,7 +89,7 @@
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Traffic Control Overview</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="">Introduction</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/overview/traffic_monitor.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/overview/traffic_monitor.html b/docs/1.7.0/overview/traffic_monitor.html
index 24853df..604b7cc 100644
--- a/docs/1.7.0/overview/traffic_monitor.html
+++ b/docs/1.7.0/overview/traffic_monitor.html
@@ -93,7 +93,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Monitor</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/overview/traffic_ops.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/overview/traffic_ops.html b/docs/1.7.0/overview/traffic_ops.html
index 270a974..56d603c 100644
--- a/docs/1.7.0/overview/traffic_ops.html
+++ b/docs/1.7.0/overview/traffic_ops.html
@@ -90,7 +90,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Traffic Control Overview</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="introduction.html">Introduction</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/overview/traffic_portal.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/overview/traffic_portal.html b/docs/1.7.0/overview/traffic_portal.html
index 77ff6b2..aa6b160 100644
--- a/docs/1.7.0/overview/traffic_portal.html
+++ b/docs/1.7.0/overview/traffic_portal.html
@@ -91,7 +91,7 @@
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Traffic Control Overview</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Portal</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/overview/traffic_router.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/overview/traffic_router.html b/docs/1.7.0/overview/traffic_router.html
index 03f9070..1d360fc 100644
--- a/docs/1.7.0/overview/traffic_router.html
+++ b/docs/1.7.0/overview/traffic_router.html
@@ -92,7 +92,7 @@
<li class="toctree-l2"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Router</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
@@ -238,16 +238,16 @@
<span id="rl-http-cr"></span><h2><img alt="arrow" src="../_images/fwda1.png" /> HTTP Content Routing<a class="headerlink" href="#arrow-http-content-routing" title="Permalink to this headline">�</a></h2>
<blockquote>
<div><p>For an HTTP delivery service the client receives a URL with a hostname beginning with <code class="docutils literal"><span class="pre">tr.</span></code> (e.g. <a class="reference external" href="http://tr.dsname.cdn.com/foo/bar/fun.html">http://tr.dsname.cdn.com/foo/bar/fun.html</a>), the LDNS server resolves this <code class="docutils literal"><span class="pre">tr.dsname.cdn.com</span></code> to an IP address, but in this case Traffic Router returns its own IP address. The client opens a connection to port 80 on the Traffic Router’s IP address, and sends:</p>
-<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
-Host: tr.dsname.cdn.com
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">tr</span><span class="o">.</span><span class="n">dsname</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
<p>Traffic Router uses an HTTP 302 to redirect the client to the best cache. For example:</p>
-<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 302 Moved Temporarily
-Server: Apache-Coyote/1.1
-Location: http://atsec-nyc-02.dsname.cdn.com/foo/bar/fun.html
-Content-Length: 0
-Date: Tue, 13 Jan 2015 20:01:41 GMT
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">302</span> <span class="n">Moved</span> <span class="n">Temporarily</span>
+<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">-</span><span class="n">Coyote</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">Location</span><span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">atsec</span><span class="o">-</span><span class="n">nyc</span><span class="o">-</span><span class="mf">02.</span><span class="n">dsname</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">0</span>
+<span class="n">Date</span><span class="p">:</span> <span class="n">Tue</span><span class="p">,</span> <span class="mi">13</span> <span class="n">Jan</span> <span class="mi">2015</span> <span class="mi">20</span><span class="p">:</span><span class="mi">01</span><span class="p">:</span><span class="mi">41</span> <span class="n">GMT</span>
</pre></div>
</div>
<p>The information Traffic Router can consider when selecting a cache in this case is much better:</p>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/overview/traffic_server.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/overview/traffic_server.html b/docs/1.7.0/overview/traffic_server.html
index f68e988..4b0a444 100644
--- a/docs/1.7.0/overview/traffic_server.html
+++ b/docs/1.7.0/overview/traffic_server.html
@@ -95,7 +95,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Server</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
@@ -196,7 +196,7 @@
<p class="first admonition-title">Note</p>
<p class="last">Often the EDGE to MID relationship is based on network distance, and does not necessarily match the geographic distance.</p>
</div>
-<p>A cache group serves a particular part of the network as defined in the coverage zone file. See <a class="reference internal" href="../admin/traffic_ops_using.html#rl-asn-czf"><em>The Coverage Zone File and ASN Table</em></a>.</p>
+<p>A cache group serves a particular part of the network as defined in the coverage zone file. See <a class="reference internal" href="../admin/traffic_ops_using.html#rl-asn-czf"><span class="std std-ref">The Coverage Zone File and ASN Table</span></a>.</p>
<p>Consider the example CDN below:</p>
<img alt="../_images/cache_groups_1.png" class="align-center" src="../_images/cache_groups_1.png" />
<p>There are two MID tier cache groups, each assigned with three EDGEs. The lax, den and chi EDGE locations are configured with the West MID as their parent, and the nyc, phl, and hou EDGEs, are configured with the East MID as their parent. On a cache miss, the EDGEs use their assigned parent.</p>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/overview/traffic_stats.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/overview/traffic_stats.html b/docs/1.7.0/overview/traffic_stats.html
index 9bdcfe3..ec4214c 100644
--- a/docs/1.7.0/overview/traffic_stats.html
+++ b/docs/1.7.0/overview/traffic_stats.html
@@ -94,7 +94,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Stats</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault</a></li>
</ul>
@@ -186,7 +186,7 @@
<span class="target" id="reference-label-tc-ts"></span><div class="section" id="traffic-stats">
<h1>Traffic Stats<a class="headerlink" href="#traffic-stats" title="Permalink to this headline">�</a></h1>
-<p>Traffic Stats is a program written in <a class="reference external" href="http://golang.org">Golang</a> that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor’s JSON APIs and stores the data in <a class="reference external" href="http://influxdb.com">InfluxDb</a>. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by <a class="reference external" href="http://grafana.org">Grafana</a> which are linked from Traffic Ops as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API’s and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the To
tal Bytes served.</p>
+<p>Traffic Stats is a program written in <a class="reference external" href="http://golang.org">Golang</a> that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor’s JSON APIs and stores the data in <a class="reference external" href="http://influxdb.com">InfluxDb</a>. Data is typically stored in InfluxDb on a short-term basis (30 days or less). The data from InfluxDb is then used to drive graphs created by <a class="reference external" href="http://grafana.org">Grafana</a> - which are linked to from Traffic Ops - as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API’s and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containi
ng the Max Gbps served and the Total Bytes served.</p>
<p>Stat data is stored in three different databases:</p>
<blockquote>
<div><ul class="simple">
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/1.7.0/overview/traffic_vault.html
----------------------------------------------------------------------
diff --git a/docs/1.7.0/overview/traffic_vault.html b/docs/1.7.0/overview/traffic_vault.html
index a2bedea..cff0729 100644
--- a/docs/1.7.0/overview/traffic_vault.html
+++ b/docs/1.7.0/overview/traffic_vault.html
@@ -96,7 +96,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Vault</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Vault</a></li>
</ul>
</li>
</ul>
[19/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/server.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/server.txt b/docs/latest/_sources/development/traffic_ops_api/v12/server.txt
index 4e308fb..316f126 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/server.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/server.txt
@@ -24,7 +24,7 @@ Server
/api/1.2/servers
++++++++++++++++
-**GET /api/1.2/servers.json**
+**GET /api/1.2/servers**
Retrieves properties of CDN servers.
@@ -34,12 +34,172 @@ Server
**Request Query Parameters**
+ +--------------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +====================+==========+=============================================+
+ | ``dsId`` | no | Used to filter servers by delivery service. |
+ +--------------------+----------+---------------------------------------------+
+ | ``status`` | no | Used to filter servers by status. |
+ +--------------------+----------+---------------------------------------------+
+ | ``type`` | no | Used to filter servers by type. |
+ +--------------------+----------+---------------------------------------------+
+ | ``profileId`` | no | Used to filter servers by profile. |
+ +--------------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/servers/:id**
+
+ Retrieves properties of a CDN server by server ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+-----------+----------+---------------------------------------------+
| Name | Required | Description |
+===========+==========+=============================================+
- | ``dsId`` | no | Used to filter servers by delivery service. |
- +-----------+----------+---------------------------------------------+
- | ``type`` | no | Used to filter servers by type. |
+ | ``id`` | yes | Server id. |
+-----------+----------+---------------------------------------------+
**Response Properties**
@@ -47,12 +207,22 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+====================+========+============================================================================================================+
- | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v12-cachegroup`). |
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``domainName`` | string | The domain name part of the FQDN of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``hostName`` | string | The host name part of the cache. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``id`` | string | The server id (database row number). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
@@ -87,9 +257,17 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``physLocation`` | string | The physical location name (see :ref:`to-api-v12-phys-loc`). |
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profile`` | string | The assigned profile name (see :ref:`to-api-v12-profile`). |
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``rack`` | string | A string indicating rack location. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
@@ -97,17 +275,17 @@ Server
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
| ``routerPortName`` | string | The human readable name of the router port. |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``status`` | string | The Status string (See :ref:`to-api-v12-status`). |
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The default HTTPS port on which the main application listens (443 for a cache in most cases). |
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The name of the type of this server (see :ref:`to-api-v12-type`). |
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppId`` | string | Deprecated. |
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``xmppPasswd`` | string | Deprecated. |
+ | ``updPending`` | bool | |
+--------------------+--------+------------------------------------------------------------------------------------------------------------+
**Response Example** ::
@@ -116,7 +294,11 @@ Server
"response": [
{
"cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
"domainName": "chi.kabletown.net",
+ "guid": null,
"hostName": "atsec-chi-00",
"id": "19",
"iloIpAddress": "172.16.2.6",
@@ -135,27 +317,30 @@ Server
"mgmtIpAddress": "",
"mgmtIpGateway": "",
"mgmtIpNetmask": "",
+ "offlineReason": "N/A",
"physLocation": "plocation-chi-1",
+ "physLocationId": "9",
"profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
"rack": "RR 119.02",
"routerHostName": "rtr-chi.kabletown.net",
"routerPortName": "2",
"status": "ONLINE",
+ "statusId": "6",
"tcpPort": "80",
"httpsPort": "443",
"type": "EDGE",
- "xmppId": "atsec-chi-00-dummyxmpp",
- "xmppPasswd": "**********"
- },
- {
- ... more server data
+ "typeId": "3",
+ "updPending": false
}
]
}
|
-**GET /api/1.2/servers/summary.json**
+
+**GET /api/1.2/servers/summary**
Retrieves a count of CDN servers by type.
@@ -201,7 +386,7 @@ Server
|
-**GET /api/1.2/servers/hostname/:name/details.json**
+**GET /api/1.2/servers/hostname/:name/details**
Retrieves the details of a server.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/status.txt b/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
index 401f088..e374527 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
@@ -24,9 +24,9 @@ Status
/api/1.2/statuses
+++++++++++++++++
-**GET /api/1.2/statuses.json**
+**GET /api/1.2/statuses**
- Retrieves a list of the server status codes available. May be useful when the status is retrieved from other APIs as a number and not a string.
+ Retrieves a list of the server status codes available.
Authentication Required: Yes
@@ -37,51 +37,92 @@ Status
+-----------------+--------+--------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=================+========+================================================================================+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+-----------------+--------+--------------------------------------------------------------------------------+
| ``name`` | string | The string equivalent of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
- | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
- +-----------------+--------+--------------------------------------------------------------------------------+
| ``description`` | string | A short description of the status |
+-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"id": "4",
"name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
"lastUpdated": "2013-02-13 16:34:29"
},
{
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "CCR_IGNORE",
"id": "5",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"
+ "name": "CCR_IGNORE",
+ "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
"id": "1",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "OFFLINE"
+ "name": "OFFLINE",
+ "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "2",
+ "name": "ONLINE",
"description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29",
- "name": "ONLINE"
+ "lastUpdated": "2013-02-13 16:34:29"
},
{
"id": "3",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
"name": "REPORTED",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
"lastUpdated": "2013-02-13 16:34:29"
}
- ],
+ ]
}
-|
+**GET /api/1.2/statuses/:id**
+
+ Retrieves a server status by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Status id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/type.txt b/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
index 90c2eeb..4238fc7 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
@@ -24,45 +24,54 @@ Types
/api/1.2/types
++++++++++++++
-**GET /api/1.2/types.json**
+**GET /api/1.1/types**
Authentication Required: Yes
- Role(s) Required: Yes
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``useInTable`` | no | Filter types by the table in which they apply |
+ +----------------+----------+----------------------------------------------------+
**Response Properties**
+----------------------+--------+------------------------------------------------+
| Parameter | Type | Description |
+======================+========+================================================+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
+ |``id`` | string | |
+----------------------+--------+------------------------------------------------+
|``name`` | string | |
+----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
|``description`` | string | |
+----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
{
"response": [
{
- "lastUpdated": "2013-10-23 15:28:31",
- "useInTable": "staticdnsentry",
- "name": "AAAA_RECORD",
"id": "22",
- "description": "Static DNS AAAA entry"
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
}
- ],
+ ]
}
+
|
-**GET /api/1.2/types/trimmed.json**
+**GET /api/1.1/types/trimmed**
Authentication Required: Yes
@@ -95,4 +104,49 @@ Types
],
}
+**GET /api/1.1/types/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``id`` | yes | Type ID. |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_ops_api/v12/user.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/user.txt b/docs/latest/_sources/development/traffic_ops_api/v12/user.txt
index 8292a6b..e81292a 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/user.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/user.txt
@@ -24,7 +24,7 @@ Users
/api/1.2/users
++++++++++++++
-**GET /api/1.2/users.json**
+**GET /api/1.2/users**
Retrieves all users.
@@ -32,82 +32,184 @@ Users
Role(s) Required: None
- **Request Query Parameters**
+ **Response Properties**
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- | username | no | The user you want to retrieve information for. |
- +-----------------+----------+---------------------------------------------------+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/users/:id**
+
+ Retrieves user by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | User id. |
+ +-----------+----------+---------------------------------------------+
**Response Properties**
- +----------------------+---------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+=========+================================================+
- |``email`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``id`` | hash | |
- +----------------------+---------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``localUser`` | boolean | |
- +----------------------+---------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``rolename`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``newUser`` | boolean | |
- +----------------------+---------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``addressLine1`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+---------+------------------------------------------------+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
**Response Example** ::
-
- [
- {
- "email": "email@email.com",
- "city": "",
- "id": "54",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "Bob Simpson",
- "localUser": false,
- "uid": "0",
- "stateOrProvince": "",
- "username": "bsimpson",
- "rolename": "portal",
- "newUser": true,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "postalCode": "",
- "gid": "0"
- }
- ]
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
|
+
**GET /api/1.2/user/current.json**
Retrieves the profile for the authenticated user.
@@ -365,7 +467,7 @@ Users
Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
-.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
+.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.2 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
Authentication Required: Yes
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/development/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_stats.txt b/docs/latest/_sources/development/traffic_stats.txt
index 186f13a..4c78bec 100644
--- a/docs/latest/_sources/development/traffic_stats.txt
+++ b/docs/latest/_sources/development/traffic_stats.txt
@@ -1,18 +1,18 @@
-..
+..
.. Copyright 2015 Comcast Cable Communications Management, LLC
-..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
Traffic Stats
*************
@@ -25,20 +25,21 @@ Software Requirements
=====================
To work on Traffic Stats you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
- * `Go 1.5.x or above <https://golang.org/doc/install>`_
+ * `Go 1.7.x or above <https://golang.org/doc/install>`_
* Access to a working instance of Traffic Ops
* Access to a working instance of Traffic Monitor
- * `InfluxDb version 0.10.0 or greater <https://influxdb.com/download/index.html>`_
+ * `InfluxDb version 1.0.0 or greater <https://influxdb.com/download/index.html>`_
Traffic Stats Project Tree Overview
=====================================
* **traffic_control/traffic_stats** - contains Go source files and Files used to create the Traffic Stats rpm.
* **traffic_control/traffic_stats/grafana/** - contains a javascript file which is installed on the grafana server. This allows Traffic Ops to create custom dashboards for Delivery Services, Caches, etc.
+ * **traffic_control/traffic_stats/influxdb_tools/** - contains one tool to create the databases and retention policies needed by Traffic Stats as well as continuous queries to downsample data; contains another tool to sync downsampled data between influxdb instances. This is is helpful if you have multiple instances and they get out of sync with data.
-Go Formatting Conventions
+Go Formatting Conventions
============================
-In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code.
+In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code. It is also recommended to use `Go lint <https://github.com/golang/lint>`_.
Installing The Developer Environment
====================================
@@ -54,6 +55,5 @@ To install the Traffic Ops Developer environment:
Test Cases
==========
- Currently there are not automated tests for Traffic Stats :(.
- We hope to remedy this problem very soon!
+ Currently there are no automated tests for Traffic Stats :( but pull requests are always welcome to fix this problem!
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_sources/overview/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_stats.txt b/docs/latest/_sources/overview/traffic_stats.txt
index 7468166..874b10d 100644
--- a/docs/latest/_sources/overview/traffic_stats.txt
+++ b/docs/latest/_sources/overview/traffic_stats.txt
@@ -1,18 +1,18 @@
-..
+..
.. Copyright 2015 Comcast Cable Communications Management, LLC
-..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
.. _reference-label-tc-ts:
.. |arrow| image:: fwda.png
@@ -20,14 +20,14 @@
Traffic Stats
=============
-Traffic Stats is a program written in `Golang <http://golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by `Grafana <http://grafana.org>`_ which are linked from Traffic Ops as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API's and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served.
+Traffic Stats is a program written in `Golang <http://golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less). The data from InfluxDb is then used to drive graphs created by `Grafana <http://grafana.org>`_ - which are linked to from Traffic Ops - as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API's and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served.
Stat data is stored in three different databases:
- cache_stats: The cache_stats database is used to store data gathered from edge caches. The `measurements <https://influxdb.com/docs/v0.9/concepts/glossary.html#measurement>`_ stored by cache are: bandwidth, maxKbps, and client_connections (ats.proxy.process.http.current_client_connections). Cache Data is stored with `tags <https://influxdb.com/docs/v0.9/concepts/glossary.html#tag>`_ for hostname, cachegroup, and CDN. Data can be queried using tags.
- - deliveryservice_stats: The deliveryservice_stats database is used to store data for delivery services. The measurements stored by delivery service are: kbps, status_4xx, status_5xx, tps_2xx, tps_3xx, tps_4xx, tps_5xx, and tps_total. Delivery Service stats are stored with tags for cachegroup, CDN, and Deliveryservice xml_id.
+ - deliveryservice_stats: The deliveryservice_stats database is used to store data for delivery services. The measurements stored by delivery service are: kbps, status_4xx, status_5xx, tps_2xx, tps_3xx, tps_4xx, tps_5xx, and tps_total. Delivery Service stats are stored with tags for cachegroup, CDN, and Deliveryservice xml_id.
- daily_stats: The daily_stats database is used to store summary data for daily activities. The stats that are currently summarized are Max Bandwidth and Bytes Served and they are stored by CDN.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_static/basic.css
----------------------------------------------------------------------
diff --git a/docs/latest/_static/basic.css b/docs/latest/_static/basic.css
index 9fa77d8..2b513f0 100644
--- a/docs/latest/_static/basic.css
+++ b/docs/latest/_static/basic.css
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -52,6 +52,8 @@ div.sphinxsidebar {
width: 230px;
margin-left: -100%;
font-size: 90%;
+ word-wrap: break-word;
+ overflow-wrap : break-word;
}
div.sphinxsidebar ul {
@@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] {
width: 170px;
}
-div.sphinxsidebar #searchbox input[type="submit"] {
- width: 30px;
-}
-
img {
border: 0;
max-width: 100%;
@@ -187,6 +185,13 @@ div.genindex-jumpbox {
/* -- general body styles --------------------------------------------------- */
+div.body p, div.body dd, div.body li, div.body blockquote {
+ -moz-hyphens: auto;
+ -ms-hyphens: auto;
+ -webkit-hyphens: auto;
+ hyphens: auto;
+}
+
a.headerlink {
visibility: hidden;
}
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_static/doctools.js
----------------------------------------------------------------------
diff --git a/docs/latest/_static/doctools.js b/docs/latest/_static/doctools.js
index c7bfe76..8163495 100644
--- a/docs/latest/_static/doctools.js
+++ b/docs/latest/_static/doctools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -124,6 +124,7 @@ var Documentation = {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
+
},
/**
@@ -252,6 +253,29 @@ var Documentation = {
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
+ },
+
+ initOnKeyListeners: function() {
+ $(document).keyup(function(event) {
+ var activeElementType = document.activeElement.tagName;
+ // don't navigate when in search box or textarea
+ if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
+ switch (event.keyCode) {
+ case 37: // left
+ var prevHref = $('link[rel="prev"]').prop('href');
+ if (prevHref) {
+ window.location.href = prevHref;
+ return false;
+ }
+ case 39: // right
+ var nextHref = $('link[rel="next"]').prop('href');
+ if (nextHref) {
+ window.location.href = nextHref;
+ return false;
+ }
+ }
+ }
+ });
}
};
@@ -260,4 +284,4 @@ _ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
-});
+});
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_static/pygments.css
----------------------------------------------------------------------
diff --git a/docs/latest/_static/pygments.css b/docs/latest/_static/pygments.css
index 57eadc0..8213e90 100644
--- a/docs/latest/_static/pygments.css
+++ b/docs/latest/_static/pygments.css
@@ -4,8 +4,10 @@
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
+.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
+.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_static/searchtools.js
----------------------------------------------------------------------
diff --git a/docs/latest/_static/searchtools.js b/docs/latest/_static/searchtools.js
index 0e794fd..066857c 100644
--- a/docs/latest/_static/searchtools.js
+++ b/docs/latest/_static/searchtools.js
@@ -2,14 +2,15 @@
* searchtools.js_t
* ~~~~~~~~~~~~~~~~
*
- * Sphinx JavaScript utilties for the full-text search.
+ * Sphinx JavaScript utilities for the full-text search.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
+/* Non-minified version JS is _stemmer.js if file is provided */
/**
* Porter Stemmer
*/
@@ -373,8 +374,7 @@ var Search = {
}
// lookup as search terms in fulltext
- results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term))
- .concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title));
+ results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
// let the scorer override scores with a custom scoring function
if (Scorer.score) {
@@ -538,23 +538,47 @@ var Search = {
/**
* search for full-text terms in the index
*/
- performTermsSearch : function(searchterms, excluded, terms, score) {
+ performTermsSearch : function(searchterms, excluded, terms, titleterms) {
var filenames = this._index.filenames;
var titles = this._index.titles;
- var i, j, file, files;
+ var i, j, file;
var fileMap = {};
+ var scoreMap = {};
var results = [];
// perform the search on the required terms
for (i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
+ var files = [];
+ var _o = [
+ {files: terms[word], score: Scorer.term},
+ {files: titleterms[word], score: Scorer.title}
+ ];
+
// no match but word was a required one
- if ((files = terms[word]) === undefined)
+ if ($u.every(_o, function(o){return o.files === undefined;})) {
break;
- if (files.length === undefined) {
- files = [files];
}
+ // found search word in contents
+ $u.each(_o, function(o) {
+ var _files = o.files;
+ if (_files === undefined)
+ return
+
+ if (_files.length === undefined)
+ _files = [_files];
+ files = files.concat(_files);
+
+ // set score for the word in each file to Scorer.term
+ for (j = 0; j < _files.length; j++) {
+ file = _files[j];
+ if (!(file in scoreMap))
+ scoreMap[file] = {}
+ scoreMap[file][word] = o.score;
+ }
+ });
+
// create the mapping
for (j = 0; j < files.length; j++) {
file = files[j];
@@ -576,7 +600,9 @@ var Search = {
// ensure that none of the excluded terms is in the search result
for (i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
- $u.contains(terms[excluded[i]] || [], file)) {
+ titleterms[excluded[i]] == file ||
+ $u.contains(terms[excluded[i]] || [], file) ||
+ $u.contains(titleterms[excluded[i]] || [], file)) {
valid = false;
break;
}
@@ -584,6 +610,9 @@ var Search = {
// if we have still a valid result we can add it to the result list
if (valid) {
+ // select one (max) score for the file.
+ // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
+ var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
results.push([filenames[file], titles[file], '', null, score]);
}
}
@@ -594,7 +623,7 @@ var Search = {
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
- * words. the first one is used to find the occurance, the
+ * words. the first one is used to find the occurrence, the
* latter for highlighting it.
*/
makeSearchSummary : function(text, keywords, hlwords) {
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/_static/websupport.js
----------------------------------------------------------------------
diff --git a/docs/latest/_static/websupport.js b/docs/latest/_static/websupport.js
index 28d65db..98e7f40 100644
--- a/docs/latest/_static/websupport.js
+++ b/docs/latest/_static/websupport.js
@@ -2,9 +2,9 @@
* websupport.js
* ~~~~~~~~~~~~~
*
- * sphinx.websupport utilties for all documentation.
+ * sphinx.websupport utilities for all documentation.
*
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/index.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/index.html b/docs/latest/admin/index.html
index 29592cc..511c279 100644
--- a/docs/latest/admin/index.html
+++ b/docs/latest/admin/index.html
@@ -100,7 +100,7 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="">Administrator’s Guide</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
@@ -300,12 +300,19 @@
<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#id3">Configuration</a></li>
</ul>
</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#https-for-http-type-delivery-services">HTTPS for Http Type Delivery Services</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#protocol-options">Protocol Options</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#certificate-retrieval">Certificate Retrieval</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#certificate-chain-ordering">Certificate Chain Ordering</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#suggested-way-of-setting-up-an-https-delivery-service">Suggested Way of Setting up an HTTPS Delivery Service</a></li>
+</ul>
+</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#configuration">Configuration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#id1">InfluxDb Tools</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#id2">InfluxDb Tools</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a><ul>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/quick_howto/dnssec.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/dnssec.html b/docs/latest/admin/quick_howto/dnssec.html
index d359f38..c5c25f2 100644
--- a/docs/latest/admin/quick_howto/dnssec.html
+++ b/docs/latest/admin/quick_howto/dnssec.html
@@ -199,7 +199,7 @@
<ol class="arabic simple">
<li>Go to Tools->Manage DNSSEC Keys choose a CDN and click Manage DNSSEC Keys</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec01.png"><img alt="../../_images/dnssec01.png" class="align-center" src="../../_images/dnssec01.png" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec01.png"><img alt="../../_images/dnssec01.png" class="align-center" src="../../_images/dnssec01.png" style="width: 1100.0px; height: 280.0px;" /></a>
<ol class="arabic" start="2">
<li><p class="first">Generate keys for a CDN by clicking Generate Keys then entering the following information:</p>
<blockquote>
@@ -213,20 +213,20 @@
<p>Depending upon the number of Delivery Services in the CDN, generating DNSSEC keys may take serveral seconds.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec02.png"><img alt="../../_images/dnssec02.png" class="align-center" src="../../_images/dnssec02.png" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec02.png"><img alt="../../_images/dnssec02.png" class="align-center" src="../../_images/dnssec02.png" style="width: 747.0px; height: 454.0px;" /></a>
<ol class="arabic" start="3">
<li><p class="first">In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN’s domain (e.g. If the CDN’s domain is ‘cdn.kabletown.net’ the parent zone is ‘kabletown.net’).</p>
<p>If you control your parent zone you can enter this information yourself, otherwise you will need to work with your DNS team to get the DS Record added to the parent zone.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec03.png"><img alt="../../_images/dnssec03.png" class="align-center" src="../../_images/dnssec03.png" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec03.png"><img alt="../../_images/dnssec03.png" class="align-center" src="../../_images/dnssec03.png" style="width: 499.1px; height: 190.4px;" /></a>
<ol class="arabic" start="4">
<li><p class="first">Once DS Record information has been added to the parent zone, DNSSEC needs to be activated for the CDN so that Traffic Router will sign responses.</p>
<p>Click on Tools -> Manage DNSSEC Keys -> Choose your CDN -> On the Manage DNSSEC Keys page click the activate DNSSEC Keys button.</p>
<p>This will add a ‘dnssec.enabled = “true”’ entry to CRConfig for the chosen CDN.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec04.png"><img alt="../../_images/dnssec04.png" class="align-center" src="../../_images/dnssec04.png" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec04.png"><img alt="../../_images/dnssec04.png" class="align-center" src="../../_images/dnssec04.png" style="width: 554.4px; height: 422.8px;" /></a>
<ol class="arabic" start="5">
<li><p class="first">DNSSEC should now be active on your CDN and Traffic Router should be signing responses.</p>
<blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/quick_howto/federations.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/federations.html b/docs/latest/admin/quick_howto/federations.html
index 241305c..2fb7c80 100644
--- a/docs/latest/admin/quick_howto/federations.html
+++ b/docs/latest/admin/quick_howto/federations.html
@@ -200,24 +200,24 @@
</div></blockquote>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation01.png"><img alt="../../_images/federation01.png" class="align-center" src="../../_images/federation01.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation01.png"><img alt="../../_images/federation01.png" class="align-center" src="../../_images/federation01.png" style="width: 804.0px; height: 690.0px;" /></a>
<ol class="arabic simple" start="2">
<li>As a user with admin priveleges, create a Federation Mapping by going to Delivery Services -> Federations and then clicking ‘Add Federation Mapping’</li>
<li>Choose the Delivery Service for the federation to be mapped to and assign it to the Federation User; click Add.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation02.png"><img alt="../../_images/federation02.png" class="align-center" src="../../_images/federation02.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation02.png"><img alt="../../_images/federation02.png" class="align-center" src="../../_images/federation02.png" style="width: 766.0px; height: 494.0px;" /></a>
<ol class="arabic" start="4">
<li><p class="first">After the Federation is added, Traffic Ops will display the Federation.</p>
<p>Changes can be made at this time or the Federation can be deleted. Notice that no resolvers have been added to the fedeation yet. This can only be done by the federation user created in step 1.</p>
<p>If no further action is necessary, the Close button will close the window and display the list of all Federations.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation03.png"><img alt="../../_images/federation03.png" class="align-center" src="../../_images/federation03.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation03.png"><img alt="../../_images/federation03.png" class="align-center" src="../../_images/federation03.png" style="width: 806.0px; height: 886.0px;" /></a>
<p><strong>The Federation user can now add resolvers to the Federation Mapping in Traffic Ops.</strong></p>
<ol class="arabic" start="5">
<li><p class="first">The federation user logs to traffic ops and stores the mojolicious cookie. The mojolicious cookie can be obtained manually using the debug tools on a web browser or via curl.</p>
<p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
HTTP/1.1 200 OK
Date: Wed, 02 Dec 2015 21:12:06 GMT
@@ -239,7 +239,7 @@ Access-Control-Allow-Origin: http://localhost:8080
<li><p class="first">The federation user sends a request to Traffic Ops to add IPV4 and/or IPV6 resolvers</p>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
{"federations": [
{ "deliveryService": "images-c1",
"mappings":
@@ -271,12 +271,12 @@ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
<li><p class="first">The resolvers added by the federation user will now visible in Traffic Ops.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation04.png"><img alt="../../_images/federation04.png" class="align-center" src="../../_images/federation04.png" /></a>
+<a class="reference internal image-reference" href="../../_images/federation04.png"><img alt="../../_images/federation04.png" class="align-center" src="../../_images/federation04.png" style="width: 802.0px; height: 875.0px;" /></a>
<ol class="arabic" start="8">
<li><p class="first">Any requests made from a client that resolves to one of the federation resolvers will now be given a CNAME from Traffic Router.</p>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ dig @tr.kabletown.net edge.images-c1.kabletown.net
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ dig @tr.kabletown.net edge.images-c1.kabletown.net
; <<>> DiG 9.7.3-RedHat-9.7.3-2.el6 <<>> @tr.kabletown.net edge.images-c1.kabletown.net
; (1 server found)
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/admin/quick_howto/index.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/index.html b/docs/latest/admin/quick_howto/index.html
index 1a6d192..3bcfa76 100644
--- a/docs/latest/admin/quick_howto/index.html
+++ b/docs/latest/admin/quick_howto/index.html
@@ -112,7 +112,7 @@
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_vault.html">Traffic Vault Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="">Quick How To Guides</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Quick How To Guides</a></li>
</ul>
</li>
</ul>
[05/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
Posted by mi...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/phys_location.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/phys_location.html b/docs/latest/development/traffic_ops_api/v12/phys_location.html
index 4765744..bd4f778 100644
--- a/docs/latest/development/traffic_ops_api/v12/phys_location.html
+++ b/docs/latest/development/traffic_ops_api/v12/phys_location.html
@@ -190,7 +190,7 @@
<span id="to-api-v12-phys-loc"></span><h1>Physical Location<a class="headerlink" href="#physical-location" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-phys-locations">
<span id="to-api-v12-phys-loc-route"></span><h2>/api/1.2/phys_locations<a class="headerlink" href="#api-1-2-phys-locations" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/phys_locations.json</strong></p>
+<p><strong>GET /api/1.2/phys_locations</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,47 +208,47 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</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>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<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">email</span></code></td>
+<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">city</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</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>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -256,40 +256,52 @@
<td>string</td>
<td> </td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
</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">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
- <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"region"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"poc"</span><span class="p">:</span> <span class="s">"John Doe"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(321) 555-1111"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"IL"</span><span class="p">,</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"john.doe@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Chicago"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"60636"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 4th Street"</span><span class="p">,</span>
- <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"chicago"</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -322,13 +334,348 @@
</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">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"Ashburn"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Ashburn"</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/phys_locations/:id</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="17%" />
+<col width="15%" />
+<col width="68%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>Physical location ID.</td>
+</tr>
+</tbody>
+</table>
+<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">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</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">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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>PUT /api/1.2/phys_locations/:id</strong></dt>
+<dd><p class="first">Update a physical location</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>Physical location id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</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">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">address</span></code></td>
+<td>yes</td>
+<td>Physical location address.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td>Physical location city.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td>Physical location comments.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>no</td>
+<td>Physical location email.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>Physical location name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td>Physical location phone.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Physical location point of contact.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>no</td>
+<td>Physical location region ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>Physical location short name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td>Physical location state.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td>Physical location zip.</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">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</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">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </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> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</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">"Physical location 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="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</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="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -421,14 +768,14 @@
</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">"my physical location1"</span><span class="p">,</span>
- <span class="s">"shortName"</span> <span class="p">:</span> <span class="s">"myphylocation1"</span><span class="p">,</span>
- <span class="s">"address"</span> <span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"city"</span> <span class="p">:</span> <span class="s">"Shanghai"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"SH"</span><span class="p">,</span>
- <span class="s">"zip"</span><span class="p">:</span> <span class="s">"200000"</span><span class="p">,</span>
- <span class="s">"comments"</span><span class="p">:</span> <span class="s">"this is physical location1"</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">"my physical location1"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span>
+ <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"this is physical location1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -507,23 +854,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre> {
- "response": {
- 'shortName': 'myphylocati',
- 'regionName': 'myregion1',
- 'name': 'my physical location1',
- 'poc': '',
- 'phone': '',
- 'comments': 'this is physical location1',
- 'state': 'SH',
- 'email': '',
- 'zip': '20000',
- 'region_id': '20',
- 'city': 'Shanghai',
- 'address': '',
- 'id': '200'
- }
-}
+<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">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span>
+ <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span>
+ <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span>
+ <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span>
+ <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span>
+ <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span>
+ <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span>
+ <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/profile.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/profile.html b/docs/latest/development/traffic_ops_api/v12/profile.html
index c85ecaf..9e7db37 100644
--- a/docs/latest/development/traffic_ops_api/v12/profile.html
+++ b/docs/latest/development/traffic_ops_api/v12/profile.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="InfluxDB" href="influxdb.html"/>
+ <link rel="next" title="Profile parameters" href="profile_parameter.html"/>
<link rel="prev" title="Physical Location" href="phys_location.html"/>
@@ -177,7 +177,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="profile_parameter.html" class="btn btn-neutral float-right" title="Profile parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -190,11 +190,31 @@
<span id="to-api-v12-profile"></span><h1>Profiles<a class="headerlink" href="#profiles" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-profiles">
<span id="to-api-v12-profiles-route"></span><h2>/api/1.2/profiles<a class="headerlink" href="#api-1-2-profiles" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/profiles.json</strong></p>
+<p><strong>GET /api/1.2/profiles</strong></p>
<blockquote>
<div><blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="13%" />
+<col width="68%" />
+</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">param</span></code></td>
+<td>no</td>
+<td>Used to filter profiles by parameter.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -229,13 +249,13 @@
</table>
</div></blockquote>
<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">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -245,7 +265,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/profiles/trimmed.json</strong></p>
+<p><strong>GET /api/1.2/profiles/trimmed</strong></p>
<blockquote>
<div><blockquote>
<div><p>Authentication Required: Yes</p>
@@ -272,10 +292,85 @@
</table>
</div></blockquote>
<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="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</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</strong></p>
+<blockquote>
+<div><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="22%" />
+<col width="16%" />
+<col width="62%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>The ID of the profile.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="10%" />
+<col width="68%" />
+</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">lastUpdated</span></code></td>
+<td>array</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">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<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="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -319,9 +414,9 @@
</div></blockquote>
</div></blockquote>
<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">"CCR_COPY"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</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">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -362,12 +457,12 @@
</table>
</div></blockquote>
<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">"id"</span><span class="p">:</span> <span class="s">"66"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -447,14 +542,14 @@
</div></blockquote>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="last 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="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="s">"id"</span><span class="p">:</span> <span class="s">"66"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_COPY"</span><span class="p">,</span>
- <span class="s">"profileCopyFrom"</span><span class="p">:</span> <span class="s">"CCR1"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"CCR_COPY description"</span><span class="p">,</span>
- <span class="s">"idCopyFrom"</span><span class="p">:</span> <span class="s">"3"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s2">"profileCopyFrom"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
+ <span class="s2">"idCopyFrom"</span><span class="p">:</span> <span class="s2">"3"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -465,6 +560,182 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>PUT /api/1.2/profiles/{:id}</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Allows user to edit a profile.</p>
+<blockquote>
+<div><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="22%" />
+<col width="13%" />
+<col width="65%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</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 new name for the profile.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>yes</td>
+<td>The new description for the profile.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span>{
+ "name": "CCR_UPDATE",
+ "description": "CCR_UPDATE description"
+}
+
+ **Response Properties**
+
+ +------------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+==================================+
+ | ``response`` | | The updated profile info. |
+ +------------------+--------+----------------------------------+
+ | ``>id`` | string | Profile id. |
+ +------------------+--------+----------------------------------+
+ | ``>name`` | string | Profile name. |
+ +------------------+--------+----------------------------------+
+ | ``>description`` | string | Profile description. |
+ +------------------+--------+----------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+--------+----------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +------------------+--------+----------------------------------+
+</pre></div>
+</div>
+<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="s2">"id"</span><span class="p">:</span> <span class="s2">"219"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_UPDATE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_UPDATE description"</span>
+ <span class="p">}</span>
+ <span class="s2">"alerts"</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">"Profile was updated: 219"</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>DELETE /api/1.2/profiles/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to delete a profile.</p>
+<blockquote>
+<div><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="31%" />
+<col width="18%" />
+<col width="51%" />
+</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">id</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+</tbody>
+</table>
+<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>
+</div></blockquote>
+<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">"Profile was deleted."</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>
</div>
</div>
@@ -474,7 +745,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="profile_parameter.html" class="btn btn-neutral float-right" title="Profile parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a>