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:35 UTC
[11/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/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>