You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by jv...@apache.org on 2016/12/19 19:35:50 UTC
[10/53] [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/system.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/system.html b/docs/latest/development/traffic_ops_api/v11/system.html
index aabcf08..340a58a 100644
--- a/docs/latest/development/traffic_ops_api/v11/system.html
+++ b/docs/latest/development/traffic_ops_api/v11/system.html
@@ -252,16 +252,16 @@ set this parameter on a production system.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"parameters"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"tm.toolname"</span><span class="p">:</span> <span class="s">"Traffic Ops"</span><span class="p">,</span>
- <span class="s">"tm.infourl"</span><span class="p">:</span> <span class="s">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
- <span class="s">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s">"tm.logourl"</span><span class="p">:</span> <span class="s">"\/images\/tc_logo.png"</span><span class="p">,</span>
- <span class="s">"tm.url"</span><span class="p">:</span> <span class="s">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
- <span class="s">"tm.instance_name"</span><span class="p">:</span> <span class="s">"Kabletown CDN"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"tm.toolname"</span><span class="p">:</span> <span class="s2">"Traffic Ops"</span><span class="p">,</span>
+ <span class="s2">"tm.infourl"</span><span class="p">:</span> <span class="s2">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
+ <span class="s2">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"tm.logourl"</span><span class="p">:</span> <span class="s2">"\/images\/tc_logo.png"</span><span class="p">,</span>
+ <span class="s2">"tm.url"</span><span class="p">:</span> <span class="s2">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
+ <span class="s2">"tm.instance_name"</span><span class="p">:</span> <span class="s2">"Kabletown CDN"</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">}</span>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/to_extension.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/to_extension.html b/docs/latest/development/traffic_ops_api/v11/to_extension.html
index c3ce3a9..b9b6d61 100644
--- a/docs/latest/development/traffic_ops_api/v11/to_extension.html
+++ b/docs/latest/development/traffic_ops_api/v11/to_extension.html
@@ -251,34 +251,34 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- script_file: "ping",
- version: "1.0.0",
- name: "ILO_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
- isactive: "1",
- id: "1",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "ILO"
- },
- {
- script_file: "ping",
- version: "1.0.0",
- name: "10G_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
- isactive: "1",
- id: "2",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "10G"
- }
- ],
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ilo_ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">9</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&
quot;</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"10G_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&quo
t;</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"10G"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
</pre></div>
</div>
<div class="line-block">
@@ -342,17 +342,17 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "name": "ILO_PING",
- "version": "1.0.0",
- "info_url": "http://foo.com/bar.html",
- "script_file": "ping",
- "isactive": "1",
- "additional_config_json": "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}",
- "description": null,
- "servercheck_short_name": "ILO"
- "type": "CHECK_EXTENSION_BOOL",
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="s2">"info_url"</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="s2">"script_file"</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="s2">"isactive"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"additional_config_json"</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -389,11 +389,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Check Extension loaded."</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Check Extension loaded."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -457,11 +457,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Extension deleted."</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Extension deleted."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/type.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/type.html b/docs/latest/development/traffic_ops_api/v11/type.html
index 8ffc8c4..1c527fe 100644
--- a/docs/latest/development/traffic_ops_api/v11/type.html
+++ b/docs/latest/development/traffic_ops_api/v11/type.html
@@ -190,10 +190,30 @@
<span id="to-api-v11-type"></span><h1>Types<a class="headerlink" href="#types" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-types">
<span id="to-api-v11-types-route"></span><h2>/api/1.1/types<a class="headerlink" href="#api-1-1-types" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/types.json</strong></p>
+<p><strong>GET /api/1.1/types</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
+<td>no</td>
+<td>Filter types by the table in which they apply</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -208,39 +228,39 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td> </td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-10-23 15:28:31"</span><span class="p">,</span>
- <span class="s">"useInTable"</span><span class="p">:</span> <span class="s">"staticdnsentry"</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
- <span class="s">"description"</span><span class="p">:</span> <span class="s">"Static DNS AAAA entry"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
<span class="p">}</span>
- <span class="p">],</span>
+ <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -248,7 +268,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/types/trimmed.json</strong></p>
+<p><strong>GET /api/1.1/types/trimmed</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -273,25 +293,103 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"ACTIVE_DIRECTORY"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ACTIVE_DIRECTORY"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"A_RECORD"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"A_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
+<p><strong>GET /api/1.1/types/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Type ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v11/user.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/user.html b/docs/latest/development/traffic_ops_api/v11/user.html
index 63fe7ac..3b51cb1 100644
--- a/docs/latest/development/traffic_ops_api/v11/user.html
+++ b/docs/latest/development/traffic_ops_api/v11/user.html
@@ -190,7 +190,7 @@
<span id="to-api-v11-users"></span><h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-1-users">
<span id="to-api-v11-users-route"></span><h2>/api/1.1/users<a class="headerlink" href="#api-1-1-users" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.1/users.json</strong></p>
+<p><strong>GET /api/1.1/users</strong></p>
<blockquote>
<div><p>Retrieves all users.</p>
<p>Authentication Required: Yes</p>
@@ -209,11 +209,35 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -221,23 +245,39 @@
<td>hash</td>
<td> </td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">localUser</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -249,15 +289,140 @@
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rolename</span></code></td>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">users</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/users/:id</strong></p>
+<blockquote>
+<div><p>Retrieves user by ID.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>User id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">registrationSent</span></code></td>
<td>string</td>
<td> </td>
</tr>
@@ -265,50 +430,58 @@
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">gid</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td>
<td>string</td>
<td> </td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">[</span>
- <span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"54"</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Bob Simpson"</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"bsimpson"</span><span class="p">,</span>
- <span class="s">"rolename"</span><span class="p">:</span> <span class="s">"portal"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
<span class="p">}</span>
-<span class="p">]</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.1/user/current.json</strong></p>
+<p><strong>GET /api/1.1/user/current</strong></p>
<blockquote>
<div><p>Retrieves the profile for the authenticated user.</p>
<p>Authentication Required: Yes</p>
@@ -398,25 +571,25 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"50"</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Callahan"</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"50"</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Callahan"</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -515,25 +688,25 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"user"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"fullName"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
- <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -571,11 +744,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"UserProfile was successfully updated."</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"UserProfile was successfully updated."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -687,23 +860,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"keyword"</span><span class="p">:</span> <span class="s">"PURGE"</span><span class="p">,</span>
- <span class="s">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"assetUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"assetType"</span><span class="p">:</span> <span class="s">"file"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"PENDING"</span><span class="p">,</span>
- <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
- <span class="s">"dsXmlId"</span><span class="p">:</span> <span class="s">"ds-xml-id"</span><span class="p">,</span>
- <span class="s">"username"</span><span class="p">:</span> <span class="s">"peewee"</span><span class="p">,</span>
- <span class="s">"parameters"</span><span class="p">:</span> <span class="s">"TTL:56h"</span><span class="p">,</span>
- <span class="s">"enteredTime"</span><span class="p">:</span> <span class="s">"2015-01-21 18:00:16"</span><span class="p">,</span>
- <span class="s">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"agent"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-21 10:45:38"</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span>
+ <span class="s2">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"assetType"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"PENDING"</span><span class="p">,</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"dsXmlId"</span><span class="p">:</span> <span class="s2">"ds-xml-id"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"peewee"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:56h"</span><span class="p">,</span>
+ <span class="s2">"enteredTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 18:00:16"</span><span class="p">,</span>
+ <span class="s2">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"agent"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 10:45:38"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -771,11 +944,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
- <span class="s">"regex"</span><span class="p">:</span> <span class="s">"/path/to/content.jpg"</span><span class="p">,</span>
- <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-27 11:08:37"</span><span class="p">,</span>
- <span class="s">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"regex"</span><span class="p">:</span> <span class="s2">"/path/to/content.jpg"</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-27 11:08:37"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -817,12 +990,12 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully created purge job for: ."</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully created purge job for: ."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -862,9 +1035,9 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"u"</span><span class="p">:</span> <span class="s">"username"</span><span class="p">,</span>
- <span class="s">"p"</span><span class="p">:</span> <span class="s">"password"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"u"</span><span class="p">:</span> <span class="s2">"username"</span><span class="p">,</span>
+ <span class="s2">"p"</span><span class="p">:</span> <span class="s2">"password"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -906,11 +1079,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully logged in."</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully logged in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -969,15 +1142,15 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"90"</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"90"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img-secure"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"280"</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img-secure"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"280"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1013,8 +1186,8 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"t"</span><span class="p">:</span> <span class="s">"token-value"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"token-value"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1056,11 +1229,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"error"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Unauthorized, please log in."</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Unauthorized, please log in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1114,11 +1287,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"You are logged out."</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"You are logged out."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1155,8 +1328,8 @@ password reset.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1204,11 +1377,11 @@ password reset.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
- <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully sent password reset to email 'email@email.com'"</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully sent password reset to email 'email@email.com'"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/v12/asn.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/asn.html b/docs/latest/development/traffic_ops_api/v12/asn.html
index 2833b99..b9b732d 100644
--- a/docs/latest/development/traffic_ops_api/v12/asn.html
+++ b/docs/latest/development/traffic_ops_api/v12/asn.html
@@ -190,7 +190,7 @@
<span id="to-api-v12-asn"></span><h1>ASN<a class="headerlink" href="#asn" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-asns">
<span id="to-api-v12-asns-route"></span><h2>/api/1.2/asns<a class="headerlink" href="#api-1-2-asns" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/asns.json</strong></p>
+<p><strong>GET /api/1.2/asns</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -208,30 +208,44 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td colspan="3"><code class="docutils literal"><span class="pre">lastUpdated</span></code> | string | The Time / Date this server entry was last updated</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
</tr>
-<tr class="row-odd"><td colspan="3"><code class="docutils literal"><span class="pre">id</span></code> | string | Local unique identifier for the ASN</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the ASN</td>
</tr>
-<tr class="row-even"><td colspan="3"><code class="docutils literal"><span class="pre">asn</span></code> | string | Autonomous System Numbers per APNIC for identifying a service provider.</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">asn</span></code></td>
+<td>string</td>
+<td>Autonomous System Numbers per APNIC for identifying a service provider.</td>
</tr>
-<tr class="row-odd"><td colspan="3"><code class="docutils literal"><span class="pre">cachegroup</span></code> | string | Related cachegroup name</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>Related cachegroup name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>Related cachegroup id</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span>
- <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7015"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"28"</span><span class="p">,</span>
- <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7016"</span><span class="p">,</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-pa-pittsburgh"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -241,6 +255,206 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>GET /api/1.2/asns/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>ASN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="8%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the ASN</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">asn</span></code></td>
+<td>string</td>
+<td>Autonomous System Numbers per APNIC for identifying a service provider.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>Related cachegroup name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>Related cachegroup id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/asns/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to edit an ASN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>ASN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">asn</span></code></td>
+<td>string</td>
+<td>ASN</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cachegroup the ASN belongs to</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">response</span></code></td>
+<td>hash</td>
+<td>The details of the update, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>id</span></code></td>
+<td>int</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>dnssecEnabled</span></code></td>
+<td>string</td>
+<td>Whether dnssec is enabled.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"cdn was updated."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
</div>
</div>