http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/868aab4e/docs/latest/development/traffic_ops_api/v12/deliveryservice.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html index 00ae2a0..05b14fd 100644 --- a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html +++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Delivery Service — Traffic Control master documentation </title> + <title>Delivery Service — Traffic Control 1.8-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 1.8-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Delivery Service Regexes" href="deliveryservice_regex.html"/> <link rel="prev" title="Change Logs" href="changelog.html"/> @@ -108,6 +108,7 @@ <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li> @@ -122,6 +123,7 @@ <li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +161,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../../../index.html">Traffic Control master</a> »</li> + <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -213,11 +215,15 @@ <td>no</td> <td>Filter delivery services by CDN ID.</td> </tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td> +<td>no</td> +<td>Filter delivery services by Profile ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> <td>no</td> <td>Filter delivery services by Type ID.</td> </tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td> <td>no</td> <td>Filter by logs enabled (true|false).</td> </tr> @@ -381,11 +387,19 @@ available).</td> </tr> <tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td> <td>float</td> -<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td> +<td><p class="first">The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. 39.7391500 or null</li> +</ul> +</td> </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td> <td>float</td> -<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td> +<td><p class="first">The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. -104.9847000 or null</li> +</ul> +</td> </tr> <tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td> <td>bool</td> @@ -520,8 +534,8 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class=" <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span> - <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span> + <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span> + <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span> <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span> <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> @@ -751,11 +765,19 @@ available).</td> </tr> <tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td> <td>float</td> -<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td> +<td><p class="first">The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. 39.7391500 or null</li> +</ul> +</td> </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td> <td>float</td> -<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td> +<td><p class="first">The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. -104.9847000 or null</li> +</ul> +</td> </tr> <tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td> <td>bool</td> @@ -897,8 +919,8 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class=" <span class="p">],</span> <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span> - <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span> + <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span> + <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span> <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span> <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> @@ -1585,6 +1607,52 @@ regional geoblocking URL.</td> </pre></div> </div> </div></blockquote> +<p><strong>DELETE /api/1.2/deliveryservice_server/:dsId/:serverId</strong></p> +<blockquote> +<div><p>Removes a server (cache) from a delivery service.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Admin or Oper (if delivery service is not assigned to user)</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="13%" /> +<col width="65%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dsId</span></code></td> +<td>yes</td> +<td>Delivery service ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">serverId</span></code></td> +<td>yes</td> +<td>Server (cache) ID.</td> +</tr> +</tbody> +</table> +<blockquote> +<div><p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Server unlinked from delivery service."</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> </div> <div class="section" id="ssl-keys"> <span id="to-api-v12-ds-sslkeys"></span><h2>SSL Keys<a class="headerlink" href="#ssl-keys" title="Permalink to this headline">¶</a></h2> @@ -2537,12 +2605,20 @@ available).</td> <td>The MID header rewrite actions to perform.</td> </tr> <tr class="row-even"><td>missLat</td> -<td>yes</td> -<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td> +<td>no</td> +<td><p class="first">The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. 39.7391500 or null</li> +</ul> +</td> </tr> <tr class="row-odd"><td>missLong</td> -<td>yes</td> -<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td> +<td>no</td> +<td><p class="first">The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. -104.9847000 or null</li> +</ul> +</td> </tr> <tr class="row-even"><td>multiSiteOrigin</td> <td>yes</td> @@ -2648,8 +2724,8 @@ be a HIT)</li> <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"missLat"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span> - <span class="s2">"missLong"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span> + <span class="s2">"missLat"</span><span class="p">:</span> <span class="mf">39.7391500</span><span class="p">,</span> + <span class="s2">"missLong"</span><span class="p">:</span> <span class="o">-</span><span class="mf">104.9847000</span><span class="p">,</span> <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> @@ -2657,276 +2733,881 @@ be a HIT)</li> <span class="p">}</span> </pre></div> </div> -<p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"response"</span><span class="p">:</span> - <span class="p">{</span> - <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span> - <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> - <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span> - <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span> - <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span> - <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span> - <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span> - <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> - <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span> - <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span> - <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span> - <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span> - <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span> - <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span> - <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span> - <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> - <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span> - <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span> - <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> - <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span> - <span class="p">}</span> - <span class="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">"Delivery service was created: 312"</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/deliveryservices/{:id}</strong></p> -<blockquote> -<div><p>Allows user to edit a delivery service.</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="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>id</td> -<td>yes</td> -<td>delivery service id.</td> -</tr> -</tbody> -</table> -<p><strong>Request Properties</strong></p> +<p><strong>Response Properties</strong></p> <table border="1" class="docutils"> <colgroup> -<col width="17%" /> -<col width="7%" /> -<col width="76%" /> +<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">Required</th> +<th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> -<tr class="row-even"><td>active</td> -<td>yes</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td> +<td>bool</td> <td>true if active, false if inactive.</td> </tr> -<tr class="row-odd"><td>cacheurl</td> -<td>no</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td> +<td>string</td> <td>Cache URL rule to apply to this delivery service.</td> </tr> -<tr class="row-even"><td>ccrDnsTtl</td> -<td>no</td> -<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host.</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td> +<td>int</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>cdnId</td> -<td>yes</td> -<td>cdn id</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td> +<td>int</td> +<td>Id of the CDN to which the delivery service belongs to.</td> </tr> -<tr class="row-even"><td>checkPath</td> -<td>no</td> +<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-odd"><td>displayName</td> -<td>yes</td> -<td>Display name</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td> +<td>string</td> +<td>The display name of the delivery service.</td> </tr> -<tr class="row-even"><td>dnsBypassCname</td> -<td>no</td> -<td>Bypass CNAME</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassCname</span></code></td> +<td>string</td> +<td> </td> </tr> -<tr class="row-odd"><td>dnsBypassIp</td> -<td>no</td> -<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the +<tr class="row-even"><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>dnsBypassIp6</td> -<td>no</td> +<tr class="row-odd"><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>dnsBypassTtl</td> -<td>no</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td> +<td>int</td> <td>The TTL of the DNS bypass response.</td> </tr> -<tr class="row-even"><td>dscp</td> -<td>yes</td> -<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td> +<td>int</td> +<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> </tr> -<tr class="row-odd"><td>edgeHeaderRewrite</td> -<td>no</td> +<tr class="row-even"><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>geoLimitRedirectURL</td> -<td>no</td> -<td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td> +<td>array</td> +<td>Entry points into the CDN for this deliveryservice.</td> </tr> -<tr class="row-odd"><td>geoLimit</td> -<td>yes</td> +<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>int</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 geo limit countries</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>geoLimitCountries</td> -<td>no</td> -<td>The geo limit countries.</td> +<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>geoProvider</td> -<td>yes</td> -<td><ul class="first last simple"> -<li>0: Maxmind(default)</li> -<li>1: Neustar</li> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td> +<td>int</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td> +<td>int</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>int</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>int</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>int</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.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td> +<td>string</td> +<td>Description field 1.</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">matchList</span></code></td> +<td>array</td> +<td>Array of matchList hashes.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>type</span></code></td> +<td>string</td> +<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td> +<td>string</td> +<td>The set Number of the matchList.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td> +<td>string</td> +<td>The regexp for the matchList.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td> +<td>int</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-odd"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td> +<td>string</td> +<td>The MID header rewrite actions to perform.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td> +<td>float</td> +<td><p class="first">The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. 39.7391500 or null</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td> +<td>float</td> +<td><p class="first">The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. -104.9847000 or null</li> +</ul> +</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td> +<td>bool</td> +<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> +</tr> +<tr class="row-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>int</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>int</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>int</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>int</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>int</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">typeId</span></code></td> +<td>int</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">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-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span> + <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span> + <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span> + <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span> + <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span> + <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"http://edge.foo-ds.foo.bar.net"</span> + <span class="p">],</span> + <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span> + <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span> + <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span> + <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span> + <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span> + <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span> + <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span> + <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span> + <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span> + <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> + <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>PUT /api/1.2/deliveryservices/{:id}</strong></p> +<blockquote> +<div><p>Allows user to edit a delivery service.</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="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>id</td> +<td>yes</td> +<td>delivery service id.</td> +</tr> +</tbody> +</table> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="17%" /> +<col width="7%" /> +<col width="76%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>active</td> +<td>yes</td> +<td>true if active, false if inactive.</td> +</tr> +<tr class="row-odd"><td>cacheurl</td> +<td>no</td> +<td>Cache URL rule to apply to this delivery service.</td> +</tr> +<tr class="row-even"><td>ccrDnsTtl</td> +<td>no</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>cdnId</td> +<td>yes</td> +<td>cdn id</td> +</tr> +<tr class="row-even"><td>checkPath</td> +<td>no</td> +<td>The path portion of the URL to check this deliveryservice for health.</td> +</tr> +<tr class="row-odd"><td>displayName</td> +<td>yes</td> +<td>Display name</td> +</tr> +<tr class="row-even"><td>dnsBypassCname</td> +<td>no</td> +<td>Bypass CNAME</td> +</tr> +<tr class="row-odd"><td>dnsBypassIp</td> +<td>no</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>dnsBypassIp6</td> +<td>no</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>dnsBypassTtl</td> +<td>no</td> +<td>The TTL of the DNS bypass response.</td> +</tr> +<tr class="row-even"><td>dscp</td> +<td>yes</td> +<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> +</tr> +<tr class="row-odd"><td>edgeHeaderRewrite</td> +<td>no</td> +<td>The EDGE header rewrite actions to perform.</td> +</tr> +<tr class="row-even"><td>geoLimitRedirectURL</td> +<td>no</td> +<td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td> +</tr> +<tr class="row-odd"><td>geoLimit</td> +<td>yes</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 geo limit countries</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>geoLimitCountries</td> +<td>no</td> +<td>The geo limit countries.</td> +</tr> +<tr class="row-odd"><td>geoProvider</td> +<td>yes</td> +<td><ul class="first last simple"> +<li>0: Maxmind(default)</li> +<li>1: Neustar</li> +</ul> +</td> +</tr> +<tr class="row-even"><td>globalMaxMbps</td> +<td>no</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>globalMaxTps</td> +<td>no</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>httpBypassFqdn</td> +<td>no</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>infoUrl</td> +<td>no</td> +<td>Use this to add a URL that points to more information about that deliveryservice.</td> +</tr> +<tr class="row-even"><td>initialDispersion</td> +<td>yes</td> +<td>Initial dispersion</td> +</tr> +<tr class="row-odd"><td>ipv6RoutingEnabled</td> +<td>yes</td> +<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td> +</tr> +<tr class="row-even"><td>logsEnabled</td> +<td>yes</td> +<td><ul class="first last simple"> +<li>false: No</li> +<li>true: Yes</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td>longDesc</td> +<td>no</td> +<td>Description field.</td> +</tr> +<tr class="row-even"><td>longDesc1</td> +<td>no</td> +<td>Description field 1.</td> +</tr> +<tr class="row-odd"><td>longDesc2</td> +<td>no</td> +<td>Description field 2.</td> +</tr> +<tr class="row-even"><td>maxDnsAnswers</td> +<td>no</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-odd"><td>midHeaderRewrite</td> +<td>no</td> +<td>The MID header rewrite actions to perform.</td> +</tr> +<tr class="row-even"><td>missLat</td> +<td>no</td> +<td><p class="first">The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. 39.7391500 or null</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td>missLong</td> +<td>no</td> +<td><p class="first">The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. -104.9847000 or null</li> +</ul> +</td> +</tr> +<tr class="row-even"><td>multiSiteOrigin</td> +<td>yes</td> +<td>1 if enabled, 0 if disabled.</td> +</tr> +<tr class="row-odd"><td>orgServerFqdn</td> +<td>yes</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>originShield</td> +<td>no</td> +<td>Origin shield</td> +</tr> +<tr class="row-odd"><td>profileId</td> +<td>no</td> +<td>DS profile ID</td> +</tr> +<tr class="row-even"><td>protocol</td> +<td>yes</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>qstringIgnore</td> +<td>yes</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>rangeRequestHandling</td> +<td>yes</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 background_fetch plugin.</li> +<li>2 Use the cache_range_requests plugin.</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td>regexRemap</td> +<td>no</td> +<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> +</tr> +<tr class="row-even"><td>regionalGeoBlocking</td> +<td>no</td> +<td>Is the Regional Geo Blocking feature enabled for this delivery service.</td> +</tr> +<tr class="row-odd"><td>remapText</td> +<td>no</td> +<td>Additional raw remap line text.</td> +</tr> +<tr class="row-even"><td>signed</td> +<td>no</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>sslKeyVersion</td> +<td>no</td> +<td>SSL key version</td> +</tr> +<tr class="row-even"><td>trRequestHeaders</td> +<td>no</td> +<td>Traffic router log request headers</td> +</tr> +<tr class="row-odd"><td>trResponseHeaders</td> +<td>no</td> +<td>Traffic router additional response headers</td> +</tr> +<tr class="row-even"><td>typeId</td> +<td>yes</td> +<td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td> +</tr> +<tr class="row-odd"><td>xmlId</td> +<td>yes</td> +<td>Unique string that describes this deliveryservice.</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">"xmlId"</span><span class="p">:</span> <span class="s2">"my_ds_1"</span><span class="p">,</span> + <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"my_ds_displayname_1"</span><span class="p">,</span> + <span class="s2">"protocol"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://10.75.168.91"</span><span class="p">,</span> + <span class="s2">"cdnId"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> + <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">42</span><span class="p">,</span> + <span class="s2">"active"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"dscp"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span> + <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> + <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> + <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"missLat"</span><span class="p">:</span> <span class="mf">39.7391500</span><span class="p">,</span> + <span class="s2">"missLong"</span><span class="p">:</span> <span class="o">-</span><span class="mf">104.9847000</span><span class="p">,</span> + <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> + <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> + <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span> +<span class="p">}</span> +</pre></div> +</div> +<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>int</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>int</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">dnsBypassCname</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td> +<td>string</td> +<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the +globalMaxMbps traffic on this deliveryservice.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td> +<td>string</td> +<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the +globalMaxMbps traffic on this deliveryservice.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td> +<td>int</td> +<td>The TTL of the DNS bypass response.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td> +<td>int</td> +<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td> +<td>string</td> +<td>The EDGE header rewrite actions to perform.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td> +<td>array</td> +<td>Entry points into the CDN for this deliveryservice.</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>int</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>globalMaxMbps</td> -<td>no</td> +<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>int</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td> +<td>int</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>globalMaxTps</td> -<td>no</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td> +<td>int</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>httpBypassFqdn</td> -<td>no</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 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>infoUrl</td> -<td>no</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>int</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-even"><td>initialDispersion</td> -<td>yes</td> -<td>Initial dispersion</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td> +<td>int</td> +<td> </td> </tr> -<tr class="row-odd"><td>ipv6RoutingEnabled</td> -<td>yes</td> +<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-even"><td>logsEnabled</td> -<td>yes</td> -<td><ul class="first last simple"> -<li>false: No</li> -<li>true: Yes</li> -</ul> -</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td> </td> </tr> -<tr class="row-odd"><td>longDesc</td> -<td>no</td> +<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.</td> </tr> -<tr class="row-even"><td>longDesc1</td> -<td>no</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td> +<td>string</td> <td>Description field 1.</td> </tr> -<tr class="row-odd"><td>longDesc2</td> -<td>no</td> +<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>maxDnsAnswers</td> -<td>no</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">matchList</span></code></td> +<td>array</td> +<td>Array of matchList hashes.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>type</span></code></td> +<td>string</td> +<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td> +<td>string</td> +<td>The set Number of the matchList.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td> +<td>string</td> +<td>The regexp for the matchList.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td> +<td>int</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-odd"><td>midHeaderRewrite</td> -<td>no</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td> +<td>string</td> <td>The MID header rewrite actions to perform.</td> </tr> -<tr class="row-even"><td>missLat</td> -<td>yes</td> -<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td> +<td>float</td> +<td><p class="first">The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. 39.7391500 or null</li> +</ul> +</td> </tr> -<tr class="row-odd"><td>missLong</td> -<td>yes</td> -<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td> +<td>float</td> +<td><p class="first">The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. -104.9847000 or null</li> +</ul> +</td> </tr> -<tr class="row-even"><td>multiSiteOrigin</td> -<td>yes</td> -<td>1 if enabled, 0 if disabled.</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td> +<td>bool</td> +<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> </tr> -<tr class="row-odd"><td>orgServerFqdn</td> -<td>yes</td> +<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>originShield</td> -<td>no</td> -<td>Origin shield</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td> +<td>string</td> +<td> </td> </tr> -<tr class="row-odd"><td>profileId</td> -<td>no</td> -<td>DS profile ID</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td> +<td>string</td> +<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td> </tr> -<tr class="row-even"><td>protocol</td> -<td>yes</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td> +<td>int</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>int</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> @@ -2934,8 +3615,8 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class=" </ul> </td> </tr> -<tr class="row-odd"><td>qstringIgnore</td> -<td>yes</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td> +<td>int</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> @@ -2943,87 +3624,61 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class=" </ul> </td> </tr> -<tr class="row-even"><td>rangeRequestHandling</td> -<td>yes</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td> +<td>int</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 background_fetch plugin.</li> +<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>regexRemap</td> -<td>no</td> +<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>regionalGeoBlocking</td> -<td>no</td> -<td>Is the Regional Geo Blocking feature enabled for this delivery service.</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td> +<td>bool</td> +<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> </tr> -<tr class="row-odd"><td>remapText</td> -<td>no</td> +<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>signed</td> -<td>no</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td> +<td>bool</td> <td><ul class="first last simple"> <li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li> <li>true: token based auth is enabled for this deliveryservice.</li> </ul> </td> </tr> -<tr class="row-odd"><td>sslKeyVersion</td> -<td>no</td> -<td>SSL key version</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td> +<td>int</td> +<td> </td> </tr> -<tr class="row-even"><td>trRequestHeaders</td> -<td>no</td> -<td>Traffic router log request headers</td> +<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>trResponseHeaders</td> -<td>no</td> -<td>Traffic router additional response headers</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td> +<td>string</td> +<td> </td> </tr> -<tr class="row-even"><td>typeId</td> -<td>yes</td> -<td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td> +<td>int</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>xmlId</td> -<td>yes</td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td> +<td>string</td> <td>Unique string that describes this deliveryservice.</td> </tr> </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">"xmlId"</span><span class="p">:</span> <span class="s2">"my_ds_1"</span><span class="p">,</span> - <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"my_ds_displayname_1"</span><span class="p">,</span> - <span class="s2">"protocol"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> - <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://10.75.168.91"</span><span class="p">,</span> - <span class="s2">"cdnId"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> - <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">42</span><span class="p">,</span> - <span class="s2">"active"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"dscp"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span> - <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> - <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"missLat"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span> - <span class="s2">"missLong"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span> - <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span> -<span class="p">}</span> -</pre></div> -</div> <p><strong>Response Example</strong></p> <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"response"</span><span class="p">:</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> @@ -3038,6 +3693,9 @@ be a HIT)</li> <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span> <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span> <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"http://edge.foo-ds.foo.bar.net"</span> + <span class="p">],</span> <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> @@ -3054,10 +3712,17 @@ be a HIT)</li> <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> + <span class="p">}</span> + <span class="p">],</span> <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span> - <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span> + <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span> + <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span> <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span> <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> @@ -3078,12 +3743,7 @@ be a HIT)</li> <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span> <span class="p">}</span> - <span class="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">"Delivery service was updated: 312"</span> - <span class="p">}</span> - <span class="p">]</span> + <span class="p">]</span> <span class="p">}</span> </pre></div> </div> @@ -3268,7 +3928,7 @@ be a HIT)</li> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'1.8-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/868aab4e/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html index fc8cb41..12d3e86 100644 --- a/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html +++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Delivery Service Regexes — Traffic Control master documentation </title> + <title>Delivery Service Regexes — Traffic Control 1.8-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 1.8-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Delivery Service Statistics" href="deliveryservice_stats.html"/> <link rel="prev" title="Delivery Service" href="deliveryservice.html"/> @@ -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 master</a> »</li> + <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -789,7 +789,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'1.8-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/868aab4e/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html index 2da9cd8..57c0747 100644 --- a/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html +++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Delivery Service Statistics — Traffic Control master documentation </title> + <title>Delivery Service Statistics — Traffic Control 1.8-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 1.8-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Divisions" href="division.html"/> <link rel="prev" title="Delivery Service Regexes" href="deliveryservice_regex.html"/> @@ -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 master</a> »</li> + <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -424,7 +424,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'1.8-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/868aab4e/docs/latest/development/traffic_ops_api/v12/division.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/division.html b/docs/latest/development/traffic_ops_api/v12/division.html index e82733c..14df2fe 100644 --- a/docs/latest/development/traffic_ops_api/v12/division.html +++ b/docs/latest/development/traffic_ops_api/v12/division.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Divisions — Traffic Control master documentation </title> + <title>Divisions — Traffic Control 1.8-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 1.8-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Federation" href="federation.html"/> <link rel="prev" title="Delivery Service Statistics" href="deliveryservice_stats.html"/> @@ -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 master</a> »</li> + <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -515,7 +515,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'1.8-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true