You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by ne...@apache.org on 2017/01/14 22:05:50 UTC
[60/75] incubator-trafficcontrol-website git commit: add master docs
to latest'
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/development/traffic_ops_api/v12/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 0b6cf22..a8ff4ed 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 1.7 documentation </title>
+ <title>Delivery Service — Traffic Control master documentation </title>
@@ -33,7 +33,7 @@
- <link rel="top" title="Traffic Control 1.7 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Delivery Service Statistics" href="deliveryservice_stats.html"/>
<link rel="prev" title="Change Logs" href="changelog.html"/>
@@ -58,7 +58,7 @@
- <img src="../../../_static/tc_logo.png" class="logo" />
+ <img src="../../../_static/tc_logo_c_only.png" class="logo" />
</a>
@@ -159,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.7</a> »</li>
+ <li><a href="../../../index.html">Traffic Control master</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -190,11 +190,35 @@
<span id="to-api-v12-ds"></span><h1>Delivery Service<a class="headerlink" href="#delivery-service" title="Permalink to this headline">�</a></h1>
<div class="section" id="api-1-2-deliveryservices">
<span id="to-api-v12-ds-route"></span><h2>/api/1.2/deliveryservices<a class="headerlink" href="#api-1-2-deliveryservices" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/deliveryservices.json</strong></p>
+<p><strong>GET /api/1.2/deliveryservices</strong></p>
<blockquote>
-<div><p>Retrieves all delivery services. 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>
+<div><p>Retrieves all delivery services. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
+<p><strong>Request Query 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">cdn</span></code></td>
+<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>
+<td>no</td>
+<td>Filter delivery services by Type ID.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -259,15 +283,11 @@ globalMaxMbps traffic on this deliveryservice.</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>
+<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-even"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
<td>string</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
@@ -278,70 +298,66 @@ globalMaxMbps traffic on this deliveryservice.</td>
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>
+<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-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
<td>string</td>
<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></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-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The deliveryservice id (database row number).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
+<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><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></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><code class="docutils literal"><span class="pre">lastUpdated</span></code></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><code class="docutils literal"><span class="pre">logsEnabled</span></code></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-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
<td>Description field 2.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></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-odd"><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-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
@@ -373,11 +389,11 @@ available).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
@@ -475,77 +491,77 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</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">"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>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ { .. },
+ { .. }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -554,9 +570,29 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</div>
<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>
+<div><p>Retrieves a specific delivery service. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Delivery service ID.</td>
+</tr>
+</tbody>
+</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -735,11 +771,11 @@ available).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
@@ -837,72 +873,72 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"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="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">"ccrDnsTtl"</span><span class="p">:</span> <span class="s">"3600"</span><span class="p">,</span>
+ <span class="s">"cdnId"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"cdnName"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
+ <span class="s">"checkPath"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"displayName"</span><span class="p">:</span> <span class="s">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s">"dnsBypassCname"</span><span class="p">:</span> <span class="s">""</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="s">""</span><span class="p">,</span>
+ <span class="s">"dnsBypassTtl"</span><span class="p">:</span> <span class="s">"30"</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">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"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="s">"geoLimit"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"geoProvider"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</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">"httpBypassFqdn"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"442"</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">"initialDispersion"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s">"logsEnabled"</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">""</span><span class="p">,</span>
+ <span class="s">"longDesc1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"longDesc2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"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="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">.foo-ds</span><span class="se">\\</span><span class="s">..*"</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">"type"</span><span class="p">:</span> <span class="s">"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="s">"maxDnsAnswers"</span><span class="p">:</span> <span class="s">"0"</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">"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">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"orgServerFqdn"</span><span class="p">:</span> <span class="s">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"5"</span><span class="p">,</span>
+ <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"ROUTER_TOP"</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">"qstringIgnore"</span><span class="p">:</span> <span class="s">"1"</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">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</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">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"sslKeyVersion"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"trResponseHeaders"</span><span class="p">:</span> <span class="s">"Access-Control-Allow-Origin: *"</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">"typeId"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
+ <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"foo-ds"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -912,10 +948,267 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<div class="line-block">
<div class="line"><br /></div>
</div>
+<p><strong>GET /api/1.2/deliveryservices/:id/servers</strong></p>
+<blockquote>
+<div><p>Retrieves properties of CDN Edge servers assigned to a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Delivery service ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><em>Cache Group</em></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><em>Status</em></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><em>Status</em></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><em>Types</em></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><em>Types</em></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"cdnId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"cdnName"</span><span class="p">:</span> <span class="s">"CDN-1"</span><span class="p">,</span>
+ <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
+ <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
+ <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
+ <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
+ <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"offlineReason"</span><span class="p">:</span> <span class="s">"N/A"</span><span class="p">,</span>
+ <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s">"physLocationId"</span><span class="p">:</span> <span class="s">"9"</span><span class="p">,</span>
+ <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s">"profileDesc"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"12"</span><span class="p">,</span>
+ <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
+ <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
+ <span class="s">"statusId"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
+ <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
+ <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
+ <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
</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>
-<p><strong>GET /api/1.2/deliveryservices/:id/state.json</strong></p>
+<p><strong>GET /api/1.2/deliveryservices/:id/state</strong></p>
<blockquote>
<div><p>Retrieves the failover state for a delivery service.</p>
<p>Authentication Required: Yes</p>
@@ -969,18 +1262,18 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"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>
+<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="p">{</span>
+ <span class="s">"location"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"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="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>
<span class="p">},</span>
- <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="s">"enabled"</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -989,7 +1282,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/deliveryservices/:id/health.json</strong></p>
+<p><strong>GET /api/1.2/deliveryservices/:id/health</strong></p>
<blockquote>
<div><p>Retrieves the health of all locations (cache groups) for a delivery service.</p>
<p>Authentication Required: Yes</p>
@@ -1036,20 +1329,20 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="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>
+<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>
<span class="p">{</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="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="p">},</span>
<span class="p">{</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="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="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -1060,7 +1353,7 @@ group.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/deliveryservices/:id/capacity.json</strong></p>
+<p><strong>GET /api/1.2/deliveryservices/:id/capacity</strong></p>
<blockquote>
<div><p>Retrieves the capacity percentages of a delivery service.</p>
<p>Authentication Required: Yes</p>
@@ -1122,12 +1415,12 @@ delivery service that is down for maintenance.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="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>
+<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>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1136,7 +1429,7 @@ delivery service that is down for maintenance.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/deliveryservices/:id/routing.json</strong></p>
+<p><strong>GET /api/1.2/deliveryservices/:id/routing</strong></p>
<blockquote>
<div><p>Retrieves the routing method percentages of a delivery service.</p>
<p>Authentication Required: Yes</p>
@@ -1216,17 +1509,17 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="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>
+<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><span class="p">,</span>
+ <span class="s">"fed"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"regionalAlternate"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"regionalDenied"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1235,7 +1528,7 @@ regional geoblocking URL.</td>
</div>
<div class="section" id="server">
<span id="to-api-v12-ds-server"></span><h2>Server<a class="headerlink" href="#server" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/deliveryserviceserver.json</strong></p>
+<p><strong>GET /api/1.2/deliveryserviceserver</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
@@ -1292,22 +1585,22 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"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>
+<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>
<span class="p">{</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="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="p">},</span>
<span class="p">{</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="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="p">},</span>
<span class="p">],</span>
- <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">2</span>
+ <span class="s">"limit"</span><span class="p">:</span> <span class="mi">2</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1315,7 +1608,7 @@ regional geoblocking URL.</td>
</div>
<div class="section" id="ssl-keys">
<span id="to-api-v12-ds-sslkeys"></span><h2>SSL Keys<a class="headerlink" href="#ssl-keys" title="Permalink to this headline">�</a></h2>
-<p><strong>GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys.json</strong></p>
+<p><strong>GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: Admin</p>
@@ -1362,9 +1655,9 @@ regional geoblocking URL.</td>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="11%" />
+<col width="13%" />
<col width="5%" />
-<col width="84%" />
+<col width="83%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -1385,6 +1678,14 @@ regional geoblocking URL.</td>
<td>string</td>
<td>base64 encoded private key file for delivery service</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>The CDN of the delivery service for which the certs were generated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">deliveryservice</span></code></td>
+<td>string</td>
+<td>The XML ID of the delivery service for which the cert was generated.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">businessUnit</span></code></td>
<td>string</td>
<td>The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
@@ -1399,7 +1700,8 @@ regional geoblocking URL.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostname</span></code></td>
<td>string</td>
-<td>The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+<td>The hostname generated by Traffic Ops that is used as the common name when generating the certificate.
+This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td>
<td>string</td>
@@ -1416,20 +1718,22 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="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>
+<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>
<span class="p">},</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="s">"deliveryservice"</span><span class="p">:</span> <span class="s">"my-ds"</span><span class="p">,</span>
+ <span class="s">"cdn"</span><span class="p">:</span> <span class="s">"qa"</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="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1438,7 +1742,7 @@ regional geoblocking URL.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/deliveryservices/hostname/:hostname/sslkeys.json</strong></p>
+<p><strong>GET /api/1.2/deliveryservices/hostname/:hostname/sslkeys</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: Admin</p>
@@ -1485,9 +1789,9 @@ regional geoblocking URL.</td>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="11%" />
+<col width="13%" />
<col width="5%" />
-<col width="84%" />
+<col width="83%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
@@ -1508,6 +1812,14 @@ regional geoblocking URL.</td>
<td>string</td>
<td>base64 encoded private key file for delivery service</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>The CDN of the delivery service for which the certs were generated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">deliveryservice</span></code></td>
+<td>string</td>
+<td>The XML ID of the delivery service for which the cert was generated.</td>
+</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">businessUnit</span></code></td>
<td>string</td>
<td>The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
@@ -1522,7 +1834,8 @@ regional geoblocking URL.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostname</span></code></td>
<td>string</td>
-<td>The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+<td>The hostname generated by Traffic Ops that is used as the common name when generating the certificate.
+This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td>
<td>string</td>
@@ -1539,20 +1852,22 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="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>
+<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>
<span class="p">},</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="s">"deliveryservice"</span><span class="p">:</span> <span class="s">"my-ds"</span><span class="p">,</span>
+ <span class="s">"cdn"</span><span class="p">:</span> <span class="s">"qa"</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="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1561,7 +1876,7 @@ regional geoblocking URL.</td>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys/delete.json</strong></p>
+<p><strong>GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys/delete</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role Required: Admin</p>
@@ -1626,8 +1941,8 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully deleted ssl keys for <xml_id>"</span>
+<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>
<span class="p">}</span>
</pre></div>
</div>
@@ -1689,20 +2004,20 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"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>
+<div class="highlight-python"><div cla
<TRUNCATED>