You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2016/11/01 21:44:31 UTC
[07/51] [partial] incubator-trafficcontrol-website git commit:
updates website files except for downloads dir
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/91716725/docs/latest/development/traffic_ops_api/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 1062d1e..0b6cf22 100644
--- a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
+++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
@@ -198,82 +198,76 @@
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="10%" />
-<col width="3%" />
-<col width="50%" />
-<col width="38%" />
+<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>
-<th class="head"> </th>
</tr>
</thead>
<tbody valign="top">
-<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>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">active</span></code></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>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></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>
-<td> </td>
-</tr>
-<tr class="row-odd"><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>
-<td> </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>
-<td> </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>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></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-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>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<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>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<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>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<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>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<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">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><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>
+<tr class="row-even"><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>
@@ -283,128 +277,137 @@ globalMaxMbps traffic on this deliveryservice.</td>
<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-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectURL</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
<td>string</td>
-<td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td>
<td> </td>
</tr>
<tr class="row-odd"><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>
-<td> </td>
</tr>
<tr class="row-even"><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>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">headerRewrite</span></code></td>
-<td>string</td>
-<td>The EDGE header rewrite actions to perform.</td>
-<td> </td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
+<tr class="row-odd"><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>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The deliveryservice id (database row number).</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
+<tr class="row-odd"><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><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
<td> </td>
</tr>
<tr class="row-odd"><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><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
<td>Description field 2.</td>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
<td>string</td>
<td>Description field 2.</td>
-<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
<td>array</td>
<td>Array of matchList hashes.</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 MatchList (one of :ref:to-api-v12-types use_in_table=’regex’).</td>
-<td> </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>
-<td> </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>
-<td> </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>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</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>
-<td> </td>
+<td>The MID header rewrite actions to perform.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</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>
-<td> </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">midHeaderRewrite</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
<td>string</td>
-<td>The MID header rewrite actions to perform.</td>
-<td> </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>string</td>
-<td> </td>
-<td>Is the Multi Site Origin feature enabled for this delivery service. See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></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-even"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
+<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"><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>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
+<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>
-<td> </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>
@@ -414,17 +417,28 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<li>2: drop query string at edge, and do not use it in the cache-key.</li>
</ul>
</td>
-<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
+<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>
-<td> </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>
-<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
<td>bool</td>
@@ -433,91 +447,112 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<li>true: token based auth is enabled for this deliveryservice.</li>
</ul>
</td>
-<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</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>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
-<td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td>
<td> </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 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,
- "protocol": "0",
- "ccrDnsTtl": "3600",
- "checkPath": "/crossdomain.xml",
- "dnsBypassIp": "",
- "dnsBypassIp6": null,
- "dnsBypassTtl": null,
- "dscp": "40",
- "geoLimit": "0",
- "geoLimitRedirectURL": "",
- "globalMaxMbps": "0",
- "globalMaxTps": "0",
- "headerRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "edgeHeaderRewrite": "add-header X-Powered-By: KABLETOWN [L]",
- "midHeaderRewrite": null,
- "httpBypassFqdn": "",
- "rangeRequestHandling": "0",
- "id": "12",
- "infoUrl": "",
- "ipv6RoutingEnabled": false,
- "longDesc": "long_desc",
- "longDesc1": "long_desc_1",
- "longDesc2": "long_desc_2",
- "matchList": [
- {
- "type": "HOST_REGEXP",
- "setNumber": "0",
- "pattern": ".*\\.images\\..*"
- }
- ],
- "maxDnsAnswers": "0",
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "orgServerFqdn": "http://cdl.origin.kabletown.net",
- "profileDescription": "Content Router for cdn2.comcast.net",
- "profileName": "EDGE_CDN2",
- "qstringIgnore": "0",
- "remapText": null,
- "regexRemap": null,
- "signed": true,
- "type": "HTTP",
- "xmlId": "cdl-c2",
- "exampleURLs": []
- },
- { .. },
- { .. }
- ],
-}
+<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">"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">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</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="o">..</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/deliveryservices/:id.json</strong></p>
+<p><strong>GET /api/1.2/deliveryservices/:id</strong></p>
<blockquote>
<div><p>Retrieves a specific delivery service. See also <a class="reference external" href="http://traffic-control-cdn.net/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
@@ -536,58 +571,65 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tr>
</thead>
<tbody valign="top">
-<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>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">active</span></code></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-even"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></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-odd"><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-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">dnsBypassIp</span></code></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-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-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<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-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<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-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<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-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<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-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<tr class="row-even"><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><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><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>
@@ -598,9 +640,13 @@ globalMaxMbps traffic on this deliveryservice.</td>
routing to the content by Traffic Router.</p>
</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectURL</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
<td>string</td>
-<td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
+<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
@@ -613,27 +659,35 @@ dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliver
traffic will be sent 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">headerRewrite</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">httpBypassFqdn</span></code></td>
+<tr class="row-odd"><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>
+<tr class="row-even"><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>
+<tr class="row-odd"><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><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
<tr class="row-odd"><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><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
@@ -652,7 +706,7 @@ globalMaxMbps traffic on this deliveryservice.</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-v12-types use_in_table=’regex’).</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>
@@ -667,32 +721,57 @@ globalMaxMbps traffic on this deliveryservice.</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">missLat</span></code></td>
+<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-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
+<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-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 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"><span class="std std-ref">Multi Site Origin</span></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"><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">profileDescription</span></code></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><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">qstringIgnore</span></code></td>
+<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>
@@ -701,15 +780,29 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</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">remapText</span></code></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><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-odd"><td><code class="docutils literal"><span class="pre">signed</span></code></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>
@@ -717,80 +810,108 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</ul>
</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</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>
+<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
-<td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td>
+<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
<td>string</td>
-<td>Entry points in to the CDN for this deliveryservice.</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><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"protocol"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"ccrDnsTtl"</span><span class="p">:</span> <span class="s">"3600"</span><span class="p">,</span>
- <span class="s">"checkPath"</span><span class="p">:</span> <span class="s">"/crossdomain.xml"</span><span class="p">,</span>
- <span class="s">"dnsBypassIp"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"dnsBypassIp6"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"dnsBypassTtl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"dscp"</span><span class="p">:</span> <span class="s">"40"</span><span class="p">,</span>
- <span class="s">"geoLimit"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"geoLimitRedirectURL"</span><span class="p">:</span><span class="s">""</span><span class="p">,</span>
- <span class="s">"globalMaxMbps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"globalMaxTps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"headerRewrite"</span><span class="p">:</span> <span class="s">"add-header X-Powered-By: KABLETOWN [L]"</span><span class="p">,</span>
- <span class="s">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="s">"add-header X-Powered-By: KABLETOWN [L]"</span><span class="p">,</span>
- <span class="s">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"httpBypassFqdn"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"rangeRequestHandling"</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">"12"</span><span class="p">,</span>
- <span class="s">"infoUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"longDesc"</span><span class="p">:</span> <span class="s">"long_desc"</span><span class="p">,</span>
- <span class="s">"longDesc1"</span><span class="p">:</span> <span class="s">"long_desc_1"</span><span class="p">,</span>
- <span class="s">"longDesc2"</span><span class="p">:</span> <span class="s">"long_desc_2"</span><span class="p">,</span>
- <span class="s">"matchList"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HOST_REGEXP"</span><span class="p">,</span>
- <span class="s">"setNumber"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">.images</span><span class="se">\\</span><span class="s">..*"</span>
- <span class="p">}</span>
- <span class="p">],</span>
- <span class="s">"maxDnsAnswers"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"missLat"</span><span class="p">:</span> <span class="s">"41.881944"</span><span class="p">,</span>
- <span class="s">"missLong"</span><span class="p">:</span> <span class="s">"-87.627778"</span><span class="p">,</span>
- <span class="s">"orgServerFqdn"</span><span class="p">:</span> <span class="s">"http://cdl.origin.kabletown.net"</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for cdn2.comcast.net"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"EDGE_CDN2"</span><span class="p">,</span>
- <span class="s">"qstringIgnore"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"signed"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HTTP"</span><span class="p">,</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"cdl-c2"</span><span class="p">,</span>
- <span class="s">"exampleURLs"</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">"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">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</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>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
</div>
<div class="section" id="health">
<span id="to-api-v12-ds-health"></span><h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">�</a></h2>
@@ -822,6 +943,14 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">>destination</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>location</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> </td>
</tr>
@@ -840,15 +969,18 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"failover"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
- <span class="s">"destination"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"enabled"</span><span class="p">:</span> <span class="n">false</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"failover"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
+ <span class="s2">"destination"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"location"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"DNS"</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="s2">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">},</span>
- <span class="s">"enabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -904,20 +1036,20 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -990,12 +1122,12 @@ delivery service that is down for maintenance.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1032,9 +1164,9 @@ delivery service that is down for maintenance.</td>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="11%" />
+<col width="16%" />
<col width="5%" />
-<col width="83%" />
+<col width="79%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -1061,24 +1193,40 @@ delivery service that is down for maintenance.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cz</span></code></td>
<td>number</td>
-<td>The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF hit.</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF (coverage zone file) hit.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dsr</span></code></td>
<td>number</td>
<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the
client to the overflow CDN.</td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">fed</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to a federated CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionalAlternate</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to the alternate
+regional geoblocking URL.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalDenied</span></code></td>
+<td>number</td>
+<td>The percent of Traffic Router requests for this deliveryservice denied due to geolocation policy.</td>
+</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"fed"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"regionalAlternate"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"regionalDenied"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1144,22 +1292,22 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
- <span class="s">"orderby"</span><span class="p">:</span> <span class="s">"deliveryservice"</span><span class="p">,</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"orderby"</span><span class="p">:</span> <span class="s2">"deliveryservice"</span><span class="p">,</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:43"</span><span class="p">,</span>
- <span class="s">"server"</span><span class="p">:</span> <span class="s">"20"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:43"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"20"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:44"</span><span class="p">,</span>
- <span class="s">"server"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
- <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:44"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">},</span>
<span class="p">],</span>
- <span class="s">"limit"</span><span class="p">:</span> <span class="mi">2</span>
+ <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">2</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1268,20 +1416,20 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
<span class="p">},</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1391,20 +1539,20 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
<span class="p">},</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1478,8 +1626,8 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully deleted ssl keys for <xml_id>"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully deleted ssl keys for <xml_id>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1541,20 +1689,20 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"ds-01"</span><span class="p">,</span>
- <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN Engineering"</span><span class="p">,</span>
- <span class="s">"version"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
- <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"key"</span><span class="p">:</span> <span class="s">"some_key"</span><span class="p">,</span>
- <span class="s">"csr"</span><span class="p">:</span> <span class="s">"some_csr"</span><span class="p">,</span>
- <span class="s">"crt"</span><span class="p">:</span> <span class="s">"some_crt"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN Engineering"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span>
<span class="p">},</span>
- <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
- <span class="s">"organization"</span><span class="p">:</span> <span class="s">"Kabletown"</span><span class="p">,</span>
- <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
- <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"Kabletown"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1588,8 +1736,8 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully created ssl keys for ds-01"</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully created ssl keys for ds-01"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1639,13 +1787,13 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"key"</sp
<TRUNCATED>