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 2017/06/07 17:32:58 UTC
[2/6] incubator-trafficcontrol-website git commit: updates latest to
match master
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/83e232ca/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 05b14fd..2ca90ee 100644
--- a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
+++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
@@ -951,9 +951,266 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</div>
<p><strong>GET /api/1.2/deliveryservices/:id/servers</strong></p>
<blockquote>
-<div><p>Retrieves properties of CDN Edge servers assigned to a delivery service. Delivery service must be assigned to user if user is not admin or operations.</p>
+<div><p>Retrieves properties of CDN EDGE or ORG servers assigned to a delivery service.</p>
<p>Authentication Required: Yes</p>
-<p>Role(s) Required: None</p>
+<p>Role(s) Required: Admin or Operations or delivery service must be assigned to user.</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>Delivery service 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 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-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-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-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-default"><div 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/deliveryservices/:id/unassigned_servers</strong></p>
+<blockquote>
+<div><p>Retrieves properties of CDN EDGE or ORG servers not assigned to a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations or delivery service must be assigned to user</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -1527,8 +1784,8 @@ regional geoblocking URL.</td>
</div>
</div></blockquote>
</div>
-<div class="section" id="server">
-<span id="to-api-v12-ds-server"></span><h2>Server<a class="headerlink" href="#server" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="delivery-service-server">
+<span id="to-api-v12-ds-server"></span><h2>Delivery Service Server<a class="headerlink" href="#delivery-service-server" title="Permalink to this headline">¶</a></h2>
<p><strong>GET /api/1.2/deliveryserviceserver</strong></p>
<blockquote>
<div><p>Retrieves delivery service / server assignments.</p>
@@ -1607,6 +1864,85 @@ regional geoblocking URL.</td>
</pre></div>
</div>
</div></blockquote>
+<p><strong>POST /api/1.2/deliveryserviceserver</strong></p>
+<blockquote>
+<div><p>Create one or more delivery service / server assignments.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations or the delivery service is assigned to the user.</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</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">dsId</span></code></td>
+<td>yes</td>
+<td>The ID of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">servers</span></code></td>
+<td>yes</td>
+<td>An array of server IDs.</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">"dsId"</span><span class="p">:</span> <span class="mi">246</span><span class="p">,</span>
+ <span class="s2">"servers"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</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">dsId</span></code></td>
+<td>int</td>
+<td>The ID of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">servers</span></code></td>
+<td>array</td>
+<td>An array of server IDs.</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">"Server assignments complete."</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">"dsId"</span> <span class="p">:</span> <span class="mi">246</span><span class="p">,</span>
+ <span class="s2">"servers"</span> <span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</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/deliveryservice_server/:dsId/:serverId</strong></p>
<blockquote>
<div><p>Removes a server (cache) from a delivery service.</p>
@@ -1654,6 +1990,134 @@ regional geoblocking URL.</td>
<div class="line"><br /></div>
</div>
</div>
+<div class="section" id="delivery-service-user">
+<span id="to-api-v12-ds-user"></span><h2>Delivery Service User<a class="headerlink" href="#delivery-service-user" title="Permalink to this headline">¶</a></h2>
+<p><strong>POST /api/1.2/deliveryservice_user</strong></p>
+<blockquote>
+<div><p>Create one or more user / delivery service assignments.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</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">userId</span></code></td>
+<td>yes</td>
+<td>The ID of the user.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryServices</span></code></td>
+<td>yes</td>
+<td>An array of delivery service IDs.</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">"userId"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">23</span><span class="p">,</span> <span class="mi">34</span><span class="p">,</span> <span class="mi">45</span><span class="p">,</span> <span class="mi">56</span><span class="p">,</span> <span class="mi">67</span> <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</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">dsId</span></code></td>
+<td>int</td>
+<td>The ID of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">servers</span></code></td>
+<td>array</td>
+<td>An array of server IDs.</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">"Delivery service assignments complete."</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">"userId"</span> <span class="p">:</span> <span class="mi">50</span><span class="p">,</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">23</span><span class="p">,</span> <span class="mi">34</span><span class="p">,</span> <span class="mi">45</span><span class="p">,</span> <span class="mi">56</span><span class="p">,</span> <span class="mi">67</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/deliveryservice_user/:dsId/:userId</strong></p>
+<blockquote>
+<div><p>Removes a delivery service from a user.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</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">dsId</span></code></td>
+<td>yes</td>
+<td>Delivery service ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">userId</span></code></td>
+<td>yes</td>
+<td>User ID.</td>
+</tr>
+</tbody>
+</table>
+<blockquote>
+<div><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">"User and delivery service were unlinked."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
<div class="section" id="ssl-keys">
<span id="to-api-v12-ds-sslkeys"></span><h2>SSL Keys<a class="headerlink" href="#ssl-keys" title="Permalink to this headline">¶</a></h2>
<p><strong>GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys</strong></p>
@@ -2625,9 +3089,10 @@ available).</td>
<td>1 if enabled, 0 if disabled.</td>
</tr>
<tr class="row-odd"><td>orgServerFqdn</td>
-<td>yes</td>
+<td>yes|no</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>
+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. This field is
+NOT required if type is ANY_MAP, STEERING OR CLIENT_STEERING.</td>
</tr>
<tr class="row-even"><td>originShield</td>
<td>no</td>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/83e232ca/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 f7be502..9e46af4 100644
--- a/docs/latest/development/traffic_ops_api/v12/parameter.html
+++ b/docs/latest/development/traffic_ops_api/v12/parameter.html
@@ -36,7 +36,7 @@
<link rel="top" title="Traffic Control 1.8-dev documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Physical Location" href="phys_location.html"/>
- <link rel="prev" title="Hardware Info" href="hwinfo.html"/>
+ <link rel="prev" title="Jobs" href="job.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -108,6 +108,7 @@
<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_monitor_golang.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>
@@ -122,6 +123,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"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</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>
@@ -180,7 +182,7 @@
<a href="phys_location.html" class="btn btn-neutral float-right" title="Physical Location">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="job.html" class="btn btn-neutral" title="Jobs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -399,13 +401,185 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/profiles/:id/parameters</strong></p>
+<p><strong>GET /api/1.2/parameters/:id/unassigned_profiles</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Retrieves all profiles NOT assigned to the parameter.</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="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">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="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>
+</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>
+</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>Retrieves all parameters assigned to the profile.</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="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">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="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>
+<p><strong>GET /api/1.2/profiles/:id/unassigned_parameters</strong></p>
+<blockquote>
+<div><p>Retrieves all parameters NOT assigned to the profile.</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="35%" />
<col width="20%" />
<col width="45%" />
@@ -1074,7 +1248,7 @@ The request route parameters accept 2 formats, both single paramter and paramete
<a href="phys_location.html" class="btn btn-neutral float-right" title="Physical Location">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="job.html" class="btn btn-neutral" title="Jobs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/83e232ca/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 450ff1b..a546c52 100644
--- a/docs/latest/development/traffic_ops_api/v12/profile.html
+++ b/docs/latest/development/traffic_ops_api/v12/profile.html
@@ -678,7 +678,8 @@
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span></code></td>
<td>int</td>
<td>no</td>
-<td>CDN ID</td>
+<td>CDN ID - must use the same ID as any
+servers assigned to the profile.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/83e232ca/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 bd0fcc1..dc84620 100644
--- a/docs/latest/development/traffic_ops_api/v12/server.html
+++ b/docs/latest/development/traffic_ops_api/v12/server.html
@@ -1101,7 +1101,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/servers/summary</strong></p>
+<p><strong>GET /api/1.2/servers/totals</strong></p>
<blockquote>
<div><p>Retrieves a count of CDN servers by type.</p>
<p>Authentication Required: Yes</p>
@@ -1160,6 +1160,69 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>GET /api/1.2/servers/status</strong></p>
+<blockquote>
+<div><p>Retrieves a count of CDN servers by status.</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="12%" />
+<col width="6%" />
+<col width="83%" />
+</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">ONLINE</span></code></td>
+<td>int</td>
+<td>The number of ONLINE servers. Traffic Monitor will not monitor the state of ONLINE servers. True health is unknown.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">REPORTED</span></code></td>
+<td>int</td>
+<td>The number of REPORTED servers. Traffic Monitor monitors the state of REPORTED servers and removes them if unhealthy.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">OFFLINE</span></code></td>
+<td>int</td>
+<td>The number of OFFLINE servers. Used for longer-term maintenance. These servers are excluded from CRConfig.json.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ADMIN_DOWN</span></code></td>
+<td>int</td>
+<td>The number of ADMIN_DOWN servers. Used for short-term maintenance. These servers are included in CRConfig.json.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">CCR_IGNORE</span></code></td>
+<td>int</td>
+<td>The number of CCR_IGNORE servers. These servers are excluded from CRConfig.json.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">PRE_PROD</span></code></td>
+<td>int</td>
+<td>The number of PRE_PROD servers. Used for servers to be deployed. These servers are excluded from CRConfig.json.</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="s2">"ONLINE"</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
+ <span class="s2">"OFFLINE"</span><span class="p">:</span> <span class="mi">23</span><span class="p">,</span>
+ <span class="s2">"REPORTED"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s2">"ADMIN_DOWN"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"CCR_IGNORE"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"PRE_PROD"</span><span class="p">:</span> <span class="mi">0</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/hostname/:name/details</strong></p>
<blockquote>
<div><p>Retrieves the details of a server.</p>
@@ -1539,8 +1602,8 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<p><strong>Request Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="22%" />
-<col width="14%" />
+<col width="21%" />
+<col width="13%" />
<col width="65%" />
</colgroup>
<thead valign="bottom">
@@ -1592,7 +1655,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tr>
<tr class="row-even"><td>profile</td>
<td>yes</td>
-<td> </td>
+<td>Profile ID - Profile’s CDN must match server’s.</td>
</tr>
<tr class="row-odd"><td>cdnName</td>
<td>yes</td>
@@ -1897,8 +1960,8 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<p><strong>Request Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="22%" />
-<col width="14%" />
+<col width="21%" />
+<col width="13%" />
<col width="65%" />
</colgroup>
<thead valign="bottom">
@@ -1950,7 +2013,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tr>
<tr class="row-even"><td>profile</td>
<td>yes</td>
-<td> </td>
+<td>Profile ID - Profile’s CDN must match server’s.</td>
</tr>
<tr class="row-odd"><td>cdnName</td>
<td>yes</td>
@@ -2227,6 +2290,110 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>PUT /api/1.2/servers/{:id}/status</strong></p>
+<blockquote>
+<div><p>Updates server status and queues updates on all child caches if server type is EDGE or MID. Also, captures offline reason if status is set to ADMIN_DOWN or OFFLINE and prepends offline reason with the user that initiated the status change.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="21%" />
+<col width="66%" />
+</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>id</td>
+<td>yes</td>
+<td>The id of the server.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<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>status</td>
+<td>yes</td>
+<td>Status ID or name.</td>
+</tr>
+<tr class="row-odd"><td>offlineReason</td>
+<td>yes|no</td>
+<td>Required if status is ADMIN_DOWN or OFFLINE.</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">"status"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"Bad drives"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<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="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>
+</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">"Updated status [ ADMIN_DOWN ] for foo.bar.net [ user23: bad drives ] and queued updates on all child caches"</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/servers/{:id}</strong></p>
<blockquote>
<div><p>Allow user to delete server through api.</p>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/83e232ca/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 7f703cc..f45b848 100644
--- a/docs/latest/development/traffic_ops_api/v12/topology.html
+++ b/docs/latest/development/traffic_ops_api/v12/topology.html
@@ -108,6 +108,7 @@
<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_monitor_golang.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>
@@ -122,6 +123,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"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</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>
@@ -190,10 +192,174 @@
<span id="to-api-v12-topology"></span><h1>Snapshot CRConfig<a class="headerlink" href="#snapshot-crconfig" title="Permalink to this headline">¶</a></h1>
<div class="section" id="api-1-2-snapshot-cdn-name">
<span id="to-api-v12-topology-route"></span><h2>/api/1.2/snapshot/{:cdn_name}<a class="headerlink" href="#api-1-2-snapshot-cdn-name" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cdns/{:cdn_name}/snapshot</strong></p>
+<blockquote>
+<div><p>Retrieves the CURRENT snapshot for a CDN which doesn’t necessarily represent the current state of the CDN. The contents of this snapshot are currently used by Traffic Monitor and Traffic Router.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="14%" />
+<col width="63%" />
+</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">cdn_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="21%" />
+<col width="7%" />
+<col width="72%" />
+</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">config</span></code></td>
+<td>hash</td>
+<td>General CDN configuration settings.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">contentRouters</span></code></td>
+<td>hash</td>
+<td>A list of Traffic Routers.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">contentServers</span></code></td>
+<td>hash</td>
+<td>A list of Traffic Servers and the delivery services associated with each.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryServices</span></code></td>
+<td>hash</td>
+<td>A list of delivery services.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeLocations</span></code></td>
+<td>hash</td>
+<td>A list of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
+<td>hash</td>
+<td>Snapshot properties.</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="s2">"config"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"contentRouters"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"contentServers"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"edgeLocations"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"stats"</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/cdns/{:cdn_name}/snapshot/new</strong></p>
+<blockquote>
+<div><p>Retrieves a PENDING snapshot for a CDN which represents the current state of the CDN. The contents of this snapshot are NOT currently used by Traffic Monitor and Traffic Router. Once a snapshot is performed, this snapshot will become the CURRENT snapshot and will be used by Traffic Monitor and Traffic Router.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="14%" />
+<col width="63%" />
+</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">cdn_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="21%" />
+<col width="7%" />
+<col width="72%" />
+</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">config</span></code></td>
+<td>hash</td>
+<td>General CDN configuration settings.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">contentRouters</span></code></td>
+<td>hash</td>
+<td>A list of Traffic Routers.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">contentServers</span></code></td>
+<td>hash</td>
+<td>A list of Traffic Servers and the delivery services associated with each.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryServices</span></code></td>
+<td>hash</td>
+<td>A list of delivery services.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeLocations</span></code></td>
+<td>hash</td>
+<td>A list of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
+<td>hash</td>
+<td>Snapshot properties.</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="s2">"config"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"contentRouters"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"contentServers"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"edgeLocations"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"stats"</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>PUT /api/1.2/snapshot/{:cdn_name}</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
-<p>Role(s) Required: admin or oper</p>
+<p>Role(s) Required: Admin or Operations</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/83e232ca/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 9c2e3ba..079cc57 100644
--- a/docs/latest/development/traffic_ops_api/v12/user.html
+++ b/docs/latest/development/traffic_ops_api/v12/user.html
@@ -506,6 +506,268 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>POST /api/1.2/users</strong></p>
+<blockquote>
+<div><p>Create a user.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="9%" />
+<col width="11%" />
+<col width="53%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</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">addressLine1</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">confirmLocalPassword</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">localPassword</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td>
+<td>bool</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td>
+<td>int</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>no</td>
+<td>Owning tenant ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">username</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td> </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">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="mi">6</span>
+ <span class="s2">"localPassword"</span><span class="p">:</span> <span class="s2">"password"</span>
+ <span class="s2">"confirmLocalPassword"</span><span class="p">:</span> <span class="s2">"password"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<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">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>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>int</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>bool</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td>
+<td>int</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>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID</td>
+</tr>
+<tr class="row-even"><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">"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">"User creation was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response: {</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="mi">0</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span><span class="n">null</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">"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">""</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span><span class="mi">6</span><span class="p">,</span>
+ <span class="s2">"roleName"</span><span class="p">:</span><span class="s2">"portal"</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">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span><span class="mi">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>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
<p><strong>GET /api/1.2/users/:id/deliveryservices</strong></p>
<blockquote>
<div><p>Retrieves all delivery services assigned to the user. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
@@ -780,23 +1042,27 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID.</td>
+</tr>
+<tr class="row-odd"><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>
+<tr class="row-even"><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>
+<tr class="row-odd"><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>
+<tr class="row-even"><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>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
<td>string</td>
<td>Unique string that describes this deliveryservice.</td>
</tr>
@@ -864,6 +1130,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<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">"tenantId"</span><span class="p">:</span> <span class="mi">1</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>
@@ -1520,7 +1787,7 @@ unnecessary work.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/user/:id/deliveryservices/available.json</strong></p>
+<p><strong>GET /api/1.2/user/:id/deliveryservices/available</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -1558,11 +1825,15 @@ unnecessary work.</td>
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</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">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -1572,12 +1843,14 @@ unnecessary work.</td>
<div class="highlight-default"><div 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">"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="s2">"id"</span><span class="p">:</span> <span class="s2">"90"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"Foo Bar DS"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-bar"</span>
<span class="p">},</span>
<span class="p">{</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="s2">"id"</span><span class="p">:</span> <span class="s2">"92"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"Foo Baz DS"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-baz"</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/83e232ca/docs/latest/objects.inv
----------------------------------------------------------------------
diff --git a/docs/latest/objects.inv b/docs/latest/objects.inv
index 8e6ed88..98de7d2 100644
Binary files a/docs/latest/objects.inv and b/docs/latest/objects.inv differ