You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by ne...@apache.org on 2017/01/14 22:11:43 UTC
[55/76] [abbrv] incubator-trafficcontrol-website git commit: add
master docs to latest'
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/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 71e28a7..f33458e 100644
--- a/docs/latest/development/traffic_ops_api/v12/user.html
+++ b/docs/latest/development/traffic_ops_api/v12/user.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Users — Traffic Control 1.7 documentation </title>
+ <title>Users — Traffic Control master documentation </title>
@@ -33,7 +33,7 @@
- <link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Snapshot CRConfig" href="topology.html"/>
<link rel="prev" title="Types" href="type.html"/>
@@ -58,7 +58,7 @@
- <img src="../../../_static/tc_logo.png" class="logo" />
+ <img src="../../../_static/tc_logo_c_only.png" class="logo" />
</a>
@@ -159,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.7</a> »</li>
+ <li><a href="../../../index.html">Traffic Control master</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -292,29 +292,29 @@
</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>
+<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="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="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</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">"city"</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">"email"</span><span class="p">:</span> <span class="s">"email1@email.com"</span><span class="p">,</span>
+ <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Simpson"</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">"id"</span><span class="p">:</span> <span class="s">"53"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2016-01-26 10:22:07"</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">"phoneNumber"</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">"publicSshKey"</span><span class="p">:</span> <span class="s">"xxx"</span><span class="p">,</span>
+ <span class="s">"registrationSent"</span><span class="p">:</span> <span class="n">true</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">"rolename"</span><span class="p">:</span> <span class="s">"admin"</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">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"username"</span><span class="p">:</span> <span class="s">"tsimpson"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="o">...</span> <span class="n">more</span> <span class="n">users</span>
@@ -449,29 +449,29 @@
</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>
+<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="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="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</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">"city"</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">"email"</span><span class="p">:</span> <span class="s">"email1@email.com"</span><span class="p">,</span>
+ <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Simpson"</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">"id"</span><span class="p">:</span> <span class="s">"53"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2016-01-26 10:22:07"</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">"phoneNumber"</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">"publicSshKey"</span><span class="p">:</span> <span class="s">"xxx"</span><span class="p">,</span>
+ <span class="s">"registrationSent"</span><span class="p">:</span> <span class="n">true</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">"rolename"</span><span class="p">:</span> <span class="s">"admin"</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">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"username"</span><span class="p">:</span> <span class="s">"tsimpson"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="o">...</span> <span class="n">more</span> <span class="n">users</span>
@@ -484,6 +484,380 @@
<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>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="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>User ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="5%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
+<td>string</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
+<td>string</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
+<td>string</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
+<td>string</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<td>string</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<td>string</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<td>string</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<td>string</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from USA</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
+<td>string</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
+<td>string</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
+<td>string</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The deliveryservice id (database row number).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
+<td>string</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<td>bool</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
+<td>string</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
+<td>string</td>
+<td>The set Number of the matchList.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
+<td>string</td>
+<td>The regexp for the matchList.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
+<td>string</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
+<td>string</td>
+<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
+<td>string</td>
+<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
+<td>string</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
+<td>string</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
+<td>string</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ { .. },
+ { .. }
+ ]
+}
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
<p><strong>GET /api/1.2/user/current.json</strong></p>
<blockquote>
<div><p>Retrieves the profile for the authenticated user.</p>
@@ -574,25 +948,25 @@
</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">"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>
+<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>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -691,25 +1065,25 @@
</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">"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>
+<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>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -752,11 +1126,11 @@
</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>
+<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>
<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">"UserProfile was successfully updated."</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="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -868,23 +1242,23 @@
</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>
+<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="p">{</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="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="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -953,11 +1327,11 @@ unnecessary work.</td>
</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="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>
+<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>
<span class="p">}</span>
</pre></div>
</div>
@@ -999,12 +1373,12 @@ unnecessary work.</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">"alerts"</span><span class="p">:</span>
+<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>
<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">"Successfully created purge job for: ."</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="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1044,9 +1418,9 @@ unnecessary work.</td>
</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">"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>
+<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>
<span class="p">}</span>
</pre></div>
</div>
@@ -1088,11 +1462,11 @@ unnecessary work.</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<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>
<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">"Successfully logged in."</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="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1151,15 +1525,15 @@ unnecessary work.</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>
+<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="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="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="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="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="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1195,8 +1569,8 @@ unnecessary work.</td>
</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">"t"</span><span class="p">:</span> <span class="s2">"token-value"</span>
+<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>
<span class="p">}</span>
</pre></div>
</div>
@@ -1238,11 +1612,11 @@ unnecessary work.</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<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>
<span class="p">{</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="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="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1296,11 +1670,11 @@ unnecessary work.</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<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>
<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">"You are logged out."</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="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1337,8 +1711,8 @@ password reset.</td>
</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">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span>
+<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>
<span class="p">}</span>
</pre></div>
</div>
@@ -1386,11 +1760,11 @@ password reset.</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">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<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>
<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">"Successfully sent password reset to email 'email@email.com'"</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="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1441,7 +1815,7 @@ password reset.</td>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.7',
+ VERSION:'master',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true