blob: a8ff4ed6b5df69655ec0703ab800d0312b5a71dd [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Delivery Service &mdash; Traffic Control master documentation </title>
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" />
<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"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="/" class="icon icon-home"> Traffic Control
<img src="../../../_static/tc_logo_c_only.png" class="logo" />
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator&#8217;s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li>
</ul>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer&#8217;s Guide</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">Traffic Control</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html">Traffic Control master</a> &raquo;</li>
<li><a href="../../index.html">Developer&#8217;s Guide</a> &raquo;</li>
<li><a href="../../traffic_ops.html">Traffic Ops</a> &raquo;</li>
<li>Delivery Service</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/development/traffic_ops_api/v12/deliveryservice.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="deliveryservice_stats.html" class="btn btn-neutral float-right" title="Delivery Service Statistics">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="changelog.html" class="btn btn-neutral" title="Change Logs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<div role="main" class="document">
<div class="section" id="delivery-service">
<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</strong></p>
<blockquote>
<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>
<col width="15%" />
<col width="5%" />
<col width="80%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
<td>bool</td>
<td>true if active, false if inactive.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
<td>string</td>
<td>Cache URL rule to apply to this delivery service.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
<td>string</td>
<td>Id of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
<td>string</td>
<td>Name of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
<td>string</td>
<td>The path portion of the URL to check this deliveryservice for health.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
<td>string</td>
<td>The display name of the delivery service.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS bypass response.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
<td>string</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -&gt; customer) traffic.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
<td>string</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
<li>1: Only route on CZF file hit</li>
<li>2: Only route on CZF hit or when from USA</li>
</ul>
<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
routing to the content by Traffic Router.</p>
</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
<td>string</td>
<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
<td>string</td>
<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
<td>string</td>
<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
<td>string</td>
<td>The deliveryservice id (database row number).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
<td>string</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
<td>bool</td>
<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
<td>bool</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
<td>Description field 1.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
<td>Description field 2.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
<td>string</td>
<td>Description field 2.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;&gt;type</span></code></td>
<td>string</td>
<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=&#8217;regex&#8217;).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;&gt;setNumber</span></code></td>
<td>string</td>
<td>The set Number of the matchList.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;&gt;pattern</span></code></td>
<td>string</td>
<td>The regexp for the matchList.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
<td>string</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
<td>string</td>
<td>The MID header rewrite actions to perform.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
<td>string</td>
<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
<td>string</td>
<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
<td>bool</td>
<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
<td>bool</td>
<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
<td>The origin server base URL (FQDN when used in this instance, includes the
protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
<td>string</td>
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
<td>string</td>
<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
<td>string</td>
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
<td>string</td>
<td><ul class="first last simple">
<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
<td>string</td>
<td><ul class="first last simple">
<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
<li>2: drop query string at edge, and do not use it in the cache-key.</li>
</ul>
</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
<td>string</td>
<td><p class="first">How to treat range requests:</p>
<ul class="last simple">
<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
<li>2 Use the cache_range_requests plugin.</li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
<td>string</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
<td>bool</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
<td>string</td>
<td>Additional raw remap line text.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
<td>bool</td>
<td><ul class="first last simple">
<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
<li>true: token based auth is enabled for this deliveryservice.</li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
<td>string</td>
<td>&nbsp;</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=&#8217;deliveryservice&#8217;).</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=&#8217;deliveryservice&#8217;).</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>{
&quot;response&quot;: [
{
&quot;active&quot;: true,
&quot;cacheurl&quot;: null,
&quot;ccrDnsTtl&quot;: &quot;3600&quot;,
&quot;cdnId&quot;: &quot;2&quot;,
&quot;cdnName&quot;: &quot;over-the-top&quot;,
&quot;checkPath&quot;: &quot;&quot;,
&quot;displayName&quot;: &quot;My Cool Delivery Service&quot;,
&quot;dnsBypassCname&quot;: &quot;&quot;,
&quot;dnsBypassIp&quot;: &quot;&quot;,
&quot;dnsBypassIp6&quot;: &quot;&quot;,
&quot;dnsBypassTtl&quot;: &quot;30&quot;,
&quot;dscp&quot;: &quot;40&quot;,
&quot;edgeHeaderRewrite&quot;: null,
&quot;exampleURLs&quot;: [
&quot;http://edge.foo-ds.foo.bar.net&quot;
],
&quot;geoLimit&quot;: &quot;0&quot;,
&quot;geoLimitCountries&quot;: null,
&quot;geoLimitRedirectURL&quot;: null,
&quot;geoProvider&quot;: &quot;0&quot;,
&quot;globalMaxMbps&quot;: null,
&quot;globalMaxTps&quot;: &quot;0&quot;,
&quot;httpBypassFqdn&quot;: &quot;&quot;,
&quot;id&quot;: &quot;442&quot;,
&quot;infoUrl&quot;: &quot;&quot;,
&quot;initialDispersion&quot;: &quot;1&quot;,
&quot;ipv6RoutingEnabled&quot;: true,
&quot;lastUpdated&quot;: &quot;2016-01-26 08:49:35&quot;,
&quot;logsEnabled&quot;: false,
&quot;longDesc&quot;: &quot;&quot;,
&quot;longDesc1&quot;: &quot;&quot;,
&quot;longDesc2&quot;: &quot;&quot;,
&quot;matchList&quot;: [
{
&quot;pattern&quot;: &quot;.*\\.foo-ds\\..*&quot;,
&quot;setNumber&quot;: &quot;0&quot;,
&quot;type&quot;: &quot;HOST_REGEXP&quot;
}
],
&quot;maxDnsAnswers&quot;: &quot;0&quot;,
&quot;midHeaderRewrite&quot;: null,
&quot;missLat&quot;: &quot;41.881944&quot;,
&quot;missLong&quot;: &quot;-87.627778&quot;,
&quot;multiSiteOrigin&quot;: false,
&quot;multiSiteOriginAlgorithm&quot;: null,
&quot;orgServerFqdn&quot;: &quot;http://baz.boo.net&quot;,
&quot;originShield&quot;: null,
&quot;profileDescription&quot;: &quot;Content Router for over-the-top&quot;,
&quot;profileId&quot;: &quot;5&quot;,
&quot;profileName&quot;: &quot;ROUTER_TOP&quot;,
&quot;protocol&quot;: &quot;0&quot;,
&quot;qstringIgnore&quot;: &quot;1&quot;,
&quot;rangeRequestHandling&quot;: &quot;0&quot;,
&quot;regexRemap&quot;: null,
&quot;regionalGeoBlocking&quot;: false,
&quot;remapText&quot;: null,
&quot;signed&quot;: false,
&quot;sslKeyVersion&quot;: &quot;0&quot;,
&quot;trRequestHeaders&quot;: null,
&quot;trResponseHeaders&quot;: &quot;Access-Control-Allow-Origin: *&quot;,
&quot;type&quot;: &quot;HTTP&quot;,
&quot;typeId&quot;: &quot;8&quot;,
&quot;xmlId&quot;: &quot;foo-ds&quot;
}
{ .. },
{ .. }
]
}
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</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://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>
<col width="15%" />
<col width="5%" />
<col width="80%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td>
<td>bool</td>
<td>true if active, false if inactive.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td>
<td>string</td>
<td>Cache URL rule to apply to this delivery service.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
<td>string</td>
<td>Id of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
<td>string</td>
<td>Name of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td>
<td>string</td>
<td>The path portion of the URL to check this deliveryservice for health.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td>
<td>string</td>
<td>The display name of the delivery service.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
<td>string</td>
<td>The TTL of the DNS bypass response.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
<td>string</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -&gt; customer) traffic.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">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>&nbsp;</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>
<li>1: Only route on CZF file hit</li>
<li>2: Only route on CZF hit or when from USA</li>
</ul>
<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
routing to the content by Traffic Router.</p>
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
<td>string</td>
<td>&nbsp;</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>
</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>
</tr>
<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-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-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>&nbsp;</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>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
<td>bool</td>
<td>&nbsp;</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>
</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>
</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>
</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">&gt;&gt;type</span></code></td>
<td>string</td>
<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=&#8217;regex&#8217;).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;&gt;setNumber</span></code></td>
<td>string</td>
<td>The set Number of the matchList.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;&gt;pattern</span></code></td>
<td>string</td>
<td>The regexp for the matchList.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
<td>string</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
<td>string</td>
<td>The MID header rewrite actions to perform.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
<td>string</td>
<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
<td>string</td>
<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
<td>bool</td>
<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
<td>bool</td>
<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
<td>The origin server base URL (FQDN when used in this instance, includes the
protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td>
<td>string</td>
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
<td>string</td>
<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
<td>string</td>
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
<td>string</td>
<td><ul class="first last simple">
<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
<td>string</td>
<td><ul class="first last simple">
<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
<li>2: drop query string at edge, and do not use it in the cache-key.</li>
</ul>
</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
<td>string</td>
<td><p class="first">How to treat range requests:</p>
<ul class="last simple">
<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
<li>2 Use the cache_range_requests plugin.</li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td>
<td>string</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td>
<td>bool</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td>
<td>string</td>
<td>Additional raw remap line text.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td>
<td>bool</td>
<td><ul class="first last simple">
<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
<li>true: token based auth is enabled for this deliveryservice.</li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td>
<td>string</td>
<td>&nbsp;</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=&#8217;deliveryservice&#8217;).</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=&#8217;deliveryservice&#8217;).</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">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;active&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s">&quot;cacheurl&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;ccrDnsTtl&quot;</span><span class="p">:</span> <span class="s">&quot;3600&quot;</span><span class="p">,</span>
<span class="s">&quot;cdnId&quot;</span><span class="p">:</span> <span class="s">&quot;2&quot;</span><span class="p">,</span>
<span class="s">&quot;cdnName&quot;</span><span class="p">:</span> <span class="s">&quot;over-the-top&quot;</span><span class="p">,</span>
<span class="s">&quot;checkPath&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;displayName&quot;</span><span class="p">:</span> <span class="s">&quot;My Cool Delivery Service&quot;</span><span class="p">,</span>
<span class="s">&quot;dnsBypassCname&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;dnsBypassIp&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;dnsBypassIp6&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;dnsBypassTtl&quot;</span><span class="p">:</span> <span class="s">&quot;30&quot;</span><span class="p">,</span>
<span class="s">&quot;dscp&quot;</span><span class="p">:</span> <span class="s">&quot;40&quot;</span><span class="p">,</span>
<span class="s">&quot;edgeHeaderRewrite&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;exampleURLs&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="s">&quot;http://edge.foo-ds.foo.bar.net&quot;</span>
<span class="p">],</span>
<span class="s">&quot;geoLimit&quot;</span><span class="p">:</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>
<span class="s">&quot;geoLimitCountries&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;geoLimitRedirectURL&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;geoProvider&quot;</span><span class="p">:</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>
<span class="s">&quot;globalMaxMbps&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;globalMaxTps&quot;</span><span class="p">:</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>
<span class="s">&quot;httpBypassFqdn&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="s">&quot;442&quot;</span><span class="p">,</span>
<span class="s">&quot;infoUrl&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;initialDispersion&quot;</span><span class="p">:</span> <span class="s">&quot;1&quot;</span><span class="p">,</span>
<span class="s">&quot;ipv6RoutingEnabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
<span class="s">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s">&quot;2016-01-26 08:49:35&quot;</span><span class="p">,</span>
<span class="s">&quot;logsEnabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s">&quot;longDesc&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;longDesc1&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;longDesc2&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;matchList&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;pattern&quot;</span><span class="p">:</span> <span class="s">&quot;.*</span><span class="se">\\</span><span class="s">.foo-ds</span><span class="se">\\</span><span class="s">..*&quot;</span><span class="p">,</span>
<span class="s">&quot;setNumber&quot;</span><span class="p">:</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;HOST_REGEXP&quot;</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="s">&quot;maxDnsAnswers&quot;</span><span class="p">:</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>
<span class="s">&quot;midHeaderRewrite&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;missLat&quot;</span><span class="p">:</span> <span class="s">&quot;41.881944&quot;</span><span class="p">,</span>
<span class="s">&quot;missLong&quot;</span><span class="p">:</span> <span class="s">&quot;-87.627778&quot;</span><span class="p">,</span>
<span class="s">&quot;multiSiteOrigin&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s">&quot;multiSiteOriginAlgorithm&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;orgServerFqdn&quot;</span><span class="p">:</span> <span class="s">&quot;http://baz.boo.net&quot;</span><span class="p">,</span>
<span class="s">&quot;originShield&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;profileDescription&quot;</span><span class="p">:</span> <span class="s">&quot;Content Router for over-the-top&quot;</span><span class="p">,</span>
<span class="s">&quot;profileId&quot;</span><span class="p">:</span> <span class="s">&quot;5&quot;</span><span class="p">,</span>
<span class="s">&quot;profileName&quot;</span><span class="p">:</span> <span class="s">&quot;ROUTER_TOP&quot;</span><span class="p">,</span>
<span class="s">&quot;protocol&quot;</span><span class="p">:</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>
<span class="s">&quot;qstringIgnore&quot;</span><span class="p">:</span> <span class="s">&quot;1&quot;</span><span class="p">,</span>
<span class="s">&quot;rangeRequestHandling&quot;</span><span class="p">:</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>
<span class="s">&quot;regexRemap&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;regionalGeoBlocking&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s">&quot;remapText&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;signed&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s">&quot;sslKeyVersion&quot;</span><span class="p">:</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>
<span class="s">&quot;trRequestHeaders&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;trResponseHeaders&quot;</span><span class="p">:</span> <span class="s">&quot;Access-Control-Allow-Origin: *&quot;</span><span class="p">,</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;HTTP&quot;</span><span class="p">,</span>
<span class="s">&quot;typeId&quot;</span><span class="p">:</span> <span class="s">&quot;8&quot;</span><span class="p">,</span>
<span class="s">&quot;xmlId&quot;</span><span class="p">:</span> <span class="s">&quot;foo-ds&quot;</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/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 &#8216;admin&#8217; 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>&nbsp;</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">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;cachegroup&quot;</span><span class="p">:</span> <span class="s">&quot;us-il-chicago&quot;</span><span class="p">,</span>
<span class="s">&quot;cachegroupId&quot;</span><span class="p">:</span> <span class="s">&quot;3&quot;</span><span class="p">,</span>
<span class="s">&quot;cdnId&quot;</span><span class="p">:</span> <span class="s">&quot;3&quot;</span><span class="p">,</span>
<span class="s">&quot;cdnName&quot;</span><span class="p">:</span> <span class="s">&quot;CDN-1&quot;</span><span class="p">,</span>
<span class="s">&quot;domainName&quot;</span><span class="p">:</span> <span class="s">&quot;chi.kabletown.net&quot;</span><span class="p">,</span>
<span class="s">&quot;guid&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;hostName&quot;</span><span class="p">:</span> <span class="s">&quot;atsec-chi-00&quot;</span><span class="p">,</span>
<span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="s">&quot;19&quot;</span><span class="p">,</span>
<span class="s">&quot;iloIpAddress&quot;</span><span class="p">:</span> <span class="s">&quot;172.16.2.6&quot;</span><span class="p">,</span>
<span class="s">&quot;iloIpGateway&quot;</span><span class="p">:</span> <span class="s">&quot;172.16.2.1&quot;</span><span class="p">,</span>
<span class="s">&quot;iloIpNetmask&quot;</span><span class="p">:</span> <span class="s">&quot;255.255.255.0&quot;</span><span class="p">,</span>
<span class="s">&quot;iloPassword&quot;</span><span class="p">:</span> <span class="s">&quot;********&quot;</span><span class="p">,</span>
<span class="s">&quot;iloUsername&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;interfaceMtu&quot;</span><span class="p">:</span> <span class="s">&quot;9000&quot;</span><span class="p">,</span>
<span class="s">&quot;interfaceName&quot;</span><span class="p">:</span> <span class="s">&quot;bond0&quot;</span><span class="p">,</span>
<span class="s">&quot;ip6Address&quot;</span><span class="p">:</span> <span class="s">&quot;2033:D0D0:3300::2:2/64&quot;</span><span class="p">,</span>
<span class="s">&quot;ip6Gateway&quot;</span><span class="p">:</span> <span class="s">&quot;2033:D0D0:3300::2:1&quot;</span><span class="p">,</span>
<span class="s">&quot;ipAddress&quot;</span><span class="p">:</span> <span class="s">&quot;10.10.2.2&quot;</span><span class="p">,</span>
<span class="s">&quot;ipGateway&quot;</span><span class="p">:</span> <span class="s">&quot;10.10.2.1&quot;</span><span class="p">,</span>
<span class="s">&quot;ipNetmask&quot;</span><span class="p">:</span> <span class="s">&quot;255.255.255.0&quot;</span><span class="p">,</span>
<span class="s">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s">&quot;2015-03-08 15:57:32&quot;</span><span class="p">,</span>
<span class="s">&quot;mgmtIpAddress&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;mgmtIpGateway&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;mgmtIpNetmask&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="s">&quot;offlineReason&quot;</span><span class="p">:</span> <span class="s">&quot;N/A&quot;</span><span class="p">,</span>
<span class="s">&quot;physLocation&quot;</span><span class="p">:</span> <span class="s">&quot;plocation-chi-1&quot;</span><span class="p">,</span>
<span class="s">&quot;physLocationId&quot;</span><span class="p">:</span> <span class="s">&quot;9&quot;</span><span class="p">,</span>
<span class="s">&quot;profile&quot;</span><span class="p">:</span> <span class="s">&quot;EDGE1_CDN1_421_SSL&quot;</span><span class="p">,</span>
<span class="s">&quot;profileDesc&quot;</span><span class="p">:</span> <span class="s">&quot;EDGE1_CDN1_421_SSL profile&quot;</span><span class="p">,</span>
<span class="s">&quot;profileId&quot;</span><span class="p">:</span> <span class="s">&quot;12&quot;</span><span class="p">,</span>
<span class="s">&quot;rack&quot;</span><span class="p">:</span> <span class="s">&quot;RR 119.02&quot;</span><span class="p">,</span>
<span class="s">&quot;routerHostName&quot;</span><span class="p">:</span> <span class="s">&quot;rtr-chi.kabletown.net&quot;</span><span class="p">,</span>
<span class="s">&quot;routerPortName&quot;</span><span class="p">:</span> <span class="s">&quot;2&quot;</span><span class="p">,</span>
<span class="s">&quot;status&quot;</span><span class="p">:</span> <span class="s">&quot;ONLINE&quot;</span><span class="p">,</span>
<span class="s">&quot;statusId&quot;</span><span class="p">:</span> <span class="s">&quot;6&quot;</span><span class="p">,</span>
<span class="s">&quot;tcpPort&quot;</span><span class="p">:</span> <span class="s">&quot;80&quot;</span><span class="p">,</span>
<span class="s">&quot;httpsPort&quot;</span><span class="p">:</span> <span class="s">&quot;443&quot;</span><span class="p">,</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;EDGE&quot;</span><span class="p">,</span>
<span class="s">&quot;typeId&quot;</span><span class="p">:</span> <span class="s">&quot;3&quot;</span><span class="p">,</span>
<span class="s">&quot;updPending&quot;</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</strong></p>
<blockquote>
<div><p>Retrieves the failover state for a delivery service.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="24%" />
<col width="12%" />
<col width="64%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">failover</span></code></td>
<td>hash</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;locations</span></code></td>
<td>array</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;destination</span></code></td>
<td>hash</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;&gt;location</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;&gt;type</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;configured</span></code></td>
<td>boolean</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;enabled</span></code></td>
<td>boolean</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">enabled</span></code></td>
<td>boolean</td>
<td>&nbsp;</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">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;failover&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;locations&quot;</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
<span class="s">&quot;destination&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;location&quot;</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;DNS&quot;</span><span class="p">,</span>
<span class="p">},</span>
<span class="s">&quot;configured&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
<span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span>
<span class="p">},</span>
<span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</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/health</strong></p>
<blockquote>
<div><p>Retrieves the health of all locations (cache groups) for a delivery service.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="24%" />
<col width="11%" />
<col width="65%" />
</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">totalOnline</span></code></td>
<td>int</td>
<td>Total number of online caches across all CDNs.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">totalOffline</span></code></td>
<td>int</td>
<td>Total number of offline caches across all CDNs.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroups</span></code></td>
<td>array</td>
<td>A collection of cache groups.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;online</span></code></td>
<td>int</td>
<td>The number of online caches for the cache group</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;offline</span></code></td>
<td>int</td>
<td>The number of offline caches for the cache
group.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;name</span></code></td>
<td>string</td>
<td>Cache group name.</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">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;totalOnline&quot;</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
<span class="s">&quot;totalOffline&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&quot;cachegroups&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;online&quot;</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
<span class="s">&quot;offline&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;us-co-denver&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">&quot;online&quot;</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
<span class="s">&quot;offline&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;us-de-newcastle&quot;</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>GET /api/1.2/deliveryservices/:id/capacity</strong></p>
<blockquote>
<div><p>Retrieves the capacity percentages of 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>id</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="29%" />
<col width="10%" />
<col width="61%" />
</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">availablePercent</span></code></td>
<td>number</td>
<td>The percentage of server capacity assigned to
the delivery service that is available.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">unavailablePercent</span></code></td>
<td>number</td>
<td>The percentage of server capacity assigned to the
delivery service that is unavailable.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">utilizedPercent</span></code></td>
<td>number</td>
<td>The percentage of server capacity assigned to the
delivery service being used.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maintenancePercent</span></code></td>
<td>number</td>
<td>The percentage of server capacity assigned to the
delivery service that is down for maintenance.</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">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;availablePercent&quot;</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
<span class="s">&quot;unavailablePercent&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&quot;utilizedPercent&quot;</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
<span class="s">&quot;maintenancePercent&quot;</span><span class="p">:</span> <span class="mf">0.0000139494071146245</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/routing</strong></p>
<blockquote>
<div><p>Retrieves the routing method percentages of 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>id</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="16%" />
<col width="5%" />
<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">staticRoute</span></code></td>
<td>number</td>
<td>The percentage of Traffic Router responses for this deliveryservice satisfied with pre-configured DNS entries.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">miss</span></code></td>
<td>number</td>
<td>The percentage of Traffic Router responses for this deliveryservice that were a miss (no location available for client IP).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">geo</span></code></td>
<td>number</td>
<td>The percentage of Traffic Router responses for this deliveryservice satisfied using 3rd party geo-IP mapping.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">err</span></code></td>
<td>number</td>
<td>The percentage of Traffic Router requests for this deliveryservice resulting in an error.</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 (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">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;staticRoute&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&quot;miss&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&quot;geo&quot;</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
<span class="s">&quot;err&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&quot;cz&quot;</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
<span class="s">&quot;dsr&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&quot;fed&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&quot;regionalAlternate&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&quot;regionalDenied&quot;</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</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</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Request Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="18%" />
<col width="16%" />
<col width="66%" />
</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">page</span></code></td>
<td>no</td>
<td>The page number for use in pagination.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">limit</span></code></td>
<td>no</td>
<td>For use in limiting the result set.</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="28%" />
<col width="10%" />
<col width="62%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>array</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">server</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">deliveryService</span></code></td>
<td>string</td>
<td>&nbsp;</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">&quot;page&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="s">&quot;orderby&quot;</span><span class="p">:</span> <span class="s">&quot;deliveryservice&quot;</span><span class="p">,</span>
<span class="s">&quot;response&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s">&quot;2014-09-26 17:53:43&quot;</span><span class="p">,</span>
<span class="s">&quot;server&quot;</span><span class="p">:</span> <span class="s">&quot;20&quot;</span><span class="p">,</span>
<span class="s">&quot;deliveryService&quot;</span><span class="p">:</span> <span class="s">&quot;1&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">&quot;lastUpdated&quot;</span><span class="p">:</span> <span class="s">&quot;2014-09-26 17:53:44&quot;</span><span class="p">,</span>
<span class="s">&quot;server&quot;</span><span class="p">:</span> <span class="s">&quot;21&quot;</span><span class="p">,</span>
<span class="s">&quot;deliveryService&quot;</span><span class="p">:</span> <span class="s">&quot;1&quot;</span>
<span class="p">},</span>
<span class="p">],</span>
<span class="s">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">2</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</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</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: Admin</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="18%" />
<col width="16%" />
<col width="66%" />
</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">xmlId</span></code></td>
<td>yes</td>
<td>xml_id of the desired delivery service</td>
</tr>
</tbody>
</table>
<p><strong>Request Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="24%" />
<col width="18%" />
<col width="58%" />
</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">version</span></code></td>
<td>no</td>
<td>The version number to retrieve</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="13%" />
<col width="5%" />
<col width="83%" />
</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">crt</span></code></td>
<td>string</td>
<td>base64 encoded crt file for delivery service</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">csr</span></code></td>
<td>string</td>
<td>base64 encoded csr file for delivery service</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">key</span></code></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>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
<td>string</td>
<td>The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">organization</span></code></td>
<td>string</td>
<td>The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostname</span></code></td>
<td>string</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>
<td>The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
<td>string</td>
<td>The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td>
<td>string</td>
<td>The version of the certificate record in Riak</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">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;certificate&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;crt&quot;</span><span class="p">:</span> <span class="s">&quot;crt&quot;</span><span class="p">,</span>
<span class="s">&quot;key&quot;</span><span class="p">:</span> <span class="s">&quot;key&quot;</span><span class="p">,</span>
<span class="s">&quot;csr&quot;</span><span class="p">:</span> <span class="s">&quot;csr&quot;</span>
<span class="p">},</span>
<span class="s">&quot;deliveryservice&quot;</span><span class="p">:</span> <span class="s">&quot;my-ds&quot;</span><span class="p">,</span>
<span class="s">&quot;cdn&quot;</span><span class="p">:</span> <span class="s">&quot;qa&quot;</span><span class="p">,</span>
<span class="s">&quot;businessUnit&quot;</span><span class="p">:</span> <span class="s">&quot;CDN_Eng&quot;</span><span class="p">,</span>
<span class="s">&quot;city&quot;</span><span class="p">:</span> <span class="s">&quot;Denver&quot;</span><span class="p">,</span>
<span class="s">&quot;organization&quot;</span><span class="p">:</span> <span class="s">&quot;KableTown&quot;</span><span class="p">,</span>
<span class="s">&quot;hostname&quot;</span><span class="p">:</span> <span class="s">&quot;foober.com&quot;</span><span class="p">,</span>
<span class="s">&quot;country&quot;</span><span class="p">:</span> <span class="s">&quot;US&quot;</span><span class="p">,</span>
<span class="s">&quot;state&quot;</span><span class="p">:</span> <span class="s">&quot;Colorado&quot;</span><span class="p">,</span>
<span class="s">&quot;version&quot;</span><span class="p">:</span> <span class="s">&quot;1&quot;</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/hostname/:hostname/sslkeys</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role(s) Required: Admin</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
<col width="13%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Required</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostname</span></code></td>
<td>yes</td>
<td>pristine hostname of the desired delivery service</td>
</tr>
</tbody>
</table>
<p><strong>Request Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="24%" />
<col width="18%" />
<col width="58%" />
</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">version</span></code></td>
<td>no</td>
<td>The version number to retrieve</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="13%" />
<col width="5%" />
<col width="83%" />
</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">crt</span></code></td>
<td>string</td>
<td>base64 encoded crt file for delivery service</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">csr</span></code></td>
<td>string</td>
<td>base64 encoded csr file for delivery service</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">key</span></code></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>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
<td>string</td>
<td>The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">organization</span></code></td>
<td>string</td>
<td>The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostname</span></code></td>
<td>string</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>
<td>The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
<td>string</td>
<td>The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td>
<td>string</td>
<td>The version of the certificate record in Riak</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">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;certificate&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;crt&quot;</span><span class="p">:</span> <span class="s">&quot;crt&quot;</span><span class="p">,</span>
<span class="s">&quot;key&quot;</span><span class="p">:</span> <span class="s">&quot;key&quot;</span><span class="p">,</span>
<span class="s">&quot;csr&quot;</span><span class="p">:</span> <span class="s">&quot;csr&quot;</span>
<span class="p">},</span>
<span class="s">&quot;deliveryservice&quot;</span><span class="p">:</span> <span class="s">&quot;my-ds&quot;</span><span class="p">,</span>
<span class="s">&quot;cdn&quot;</span><span class="p">:</span> <span class="s">&quot;qa&quot;</span><span class="p">,</span>
<span class="s">&quot;businessUnit&quot;</span><span class="p">:</span> <span class="s">&quot;CDN_Eng&quot;</span><span class="p">,</span>
<span class="s">&quot;city&quot;</span><span class="p">:</span> <span class="s">&quot;Denver&quot;</span><span class="p">,</span>
<span class="s">&quot;organization&quot;</span><span class="p">:</span> <span class="s">&quot;KableTown&quot;</span><span class="p">,</span>
<span class="s">&quot;hostname&quot;</span><span class="p">:</span> <span class="s">&quot;foober.com&quot;</span><span class="p">,</span>
<span class="s">&quot;country&quot;</span><span class="p">:</span> <span class="s">&quot;US&quot;</span><span class="p">,</span>
<span class="s">&quot;state&quot;</span><span class="p">:</span> <span class="s">&quot;Colorado&quot;</span><span class="p">,</span>
<span class="s">&quot;version&quot;</span><span class="p">:</span> <span class="s">&quot;1&quot;</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/xmlId/:xmlid/sslkeys/delete</strong></p>
<blockquote>
<div><p>Authentication Required: Yes</p>
<p>Role Required: Admin</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="18%" />
<col width="16%" />
<col width="66%" />
</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">xmlId</span></code></td>
<td>yes</td>
<td>xml_id of the desired delivery service</td>
</tr>
</tbody>
</table>
<p><strong>Request Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="24%" />
<col width="18%" />
<col width="58%" />
</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">version</span></code></td>
<td>no</td>
<td>The version number to retrieve</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="35%" />
<col width="20%" />
<col width="45%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">response</span></code></td>
<td>string</td>
<td>success response</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">&quot;response&quot;</span><span class="p">:</span> <span class="s">&quot;Successfully deleted ssl keys for &lt;xml_id&gt;&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>POST /api/1.2/deliveryservices/sslkeys/generate</strong></p>
<blockquote>
<div><p>Generates SSL crt, csr, and private key for a delivery service</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: Admin</p>
<p><strong>Request Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
<col width="13%" />
<col width="68%" />
</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">key</span></code></td>
<td>string</td>
<td>xml_id of the delivery service</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td>
<td>string</td>
<td>version of the keys being generated</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostname</span></code></td>
<td>string</td>
<td>the <em>pristine hostname</em> of the delivery service</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">org</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">unit</span></code></td>
<td>boolean</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Request Example</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;key&quot;</span><span class="p">:</span> <span class="s">&quot;ds-01&quot;</span><span class="p">,</span>
<span class="s">&quot;businessUnit&quot;</span><span class="p">:</span> <span class="s">&quot;CDN Engineering&quot;</span><span class="p">,</span>
<span class="s">&quot;version&quot;</span><span class="p">:</span> <span class="s">&quot;3&quot;</span><span class="p">,</span>
<span class="s">&quot;hostname&quot;</span><span class="p">:</span> <span class="s">&quot;tr.ds-01.ott.kabletown.com&quot;</span><span class="p">,</span>
<span class="s">&quot;certificate&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;key&quot;</span><span class="p">:</span> <span class="s">&quot;some_key&quot;</span><span class="p">,</span>
<span class="s">&quot;csr&quot;</span><span class="p">:</span> <span class="s">&quot;some_csr&quot;</span><span class="p">,</span>
<span class="s">&quot;crt&quot;</span><span class="p">:</span> <span class="s">&quot;some_crt&quot;</span>
<span class="p">},</span>
<span class="s">&quot;country&quot;</span><span class="p">:</span> <span class="s">&quot;US&quot;</span><span class="p">,</span>
<span class="s">&quot;organization&quot;</span><span class="p">:</span> <span class="s">&quot;Kabletown&quot;</span><span class="p">,</span>
<span class="s">&quot;city&quot;</span><span class="p">:</span> <span class="s">&quot;Denver&quot;</span><span class="p">,</span>
<span class="s">&quot;state&quot;</span><span class="p">:</span> <span class="s">&quot;Colorado&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<blockquote>
<div><p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="36%" />
<col width="21%" />
<col width="44%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">response</span></code></td>
<td>string</td>
<td>response string</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td>
<td>string</td>
<td>API version</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">&quot;response&quot;</span><span class="p">:</span> <span class="s">&quot;Successfully created ssl keys for ds-01&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>POST /api/1.2/deliveryservices/sslkeys/add</strong></p>
<blockquote>
<div><p>Allows user to add SSL crt, csr, and private key for a delivery service.</p>
<p>Authentication Required: Yes</p>